Class: ClassOrganizer

• Inheritance
• Description
• Class protocol
  • defaults
  • instance creation
• Instance protocol
  • Compatibility-Squeak
  • accessing
  • change & update
  • changing
  • printing & storing
  • private access

Inheritance:

   Object
   |
   +--ClassOrganizer

Package:

stx:libbasic3

Category:

Kernel-Support

Version:

rev: 1.24 date: 2019/06/08 14:53:23

user: cg

file: ClassOrganizer.st directory: libbasic3

module: stx stc-classLibrary: libbasic3

Author:

Claus Gittinger

Description:

in contrast to other smalltalks, ST/X does not keep the
method <-> category associations in the class (as organization),
but instead keeps the category as an instance variable of methods.

For compatibility with (fileOut-) files which include a class organization
message, 'aClass organization' returns an instance of this class, which
implements the category change functionality.
Also, some PD code seems to use & define methods for ClassOrganizers 
- having this (somewhat dummy) class around helps to fileIn that code.

Notice, that instances of ClassOrganizer are NOT used in the current ST/X
system; all of this is pure compatibility mimicri.


This is an additional goody class; therefore:

THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTOR ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE CONTRIBUTOR BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

Class protocol:

 defaultProtocol

 for: aClass

create & return a new instance of myself, to organize aClass

Instance protocol:

 commentStamp
( an extension from the stx:libcompat package )

 addCategory: aCategory

ignored.

usage example(s):

Number organization addCategory:'foo'.

 addCategory: aCategory before: symbolOrNil

ignored.

 categories

return a collection of my classes method-categorySymbols

usage example(s):

SmallInteger organization categories

 categoryOfElement: aSelectorSymbol

return the category for the method specified by aSelectorSymbol.
Return nil, if there is no such method.

usage example(s):

Number organization categoryOfElement:#foo. Object organization categoryOfElement:#==

 classComment

return the classes comment

usage example(s):

Number organization classComment

 elements

return a collection of my classes selectors

usage example(s):

SmallInteger organization elements

 listAtCategoryNamed: aCategorySymbol

return a collection of selectors whose methods are categorized
as aCategorySymbol

usage example(s):

SmallInteger organization listAtCategoryNamed:#arithmetic

 removeCategory: aCategory

remove a categories assignments - dummy here

 update: something with: parameter from: changedObject

(comment from inherited method)
dependent is notified of some change -
Default is to try update:with:

 changeFromString: organizationString

take category<->selector associations from aString, and change
the categories of those methods.
Only required when filing in ST-80 code, which changes the categorization
this way.

usage example(s):

TestClass organization changeFromString:'( ''category1'' #foo1 #foo2 foo3) ( ''category2'' #bar1 #bar2)'

 classify: aSelector under: aCategory

change the category of the method stored under aSelector
to aCategory.

 printOn: aStream

Number organization printString

 class: aClass

set the class