All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class key.Atom

java.lang.Object
   |
   +----key.Atom

public class Atom

extends Object

implements Storable, Symbol, HasParent

allProperties

deleteAction

is allowed to remove this atom from its parent

idProperty

modifyAction

is allowed to modify the properties of this atom.

moveAction

is allowed to change the parent of this atom - ie, move it around.

nameProperty

owner

ownerId

ownerProperty

parentProperty

permissionList

possessAction

is allowed to setOwnership of this atom.

referenceCountProperty

staticActions

The list of actions for Atom's.

Atom()

addAtomicProperty(String, Type)

addAtomicProperty(String, Type, Atom)

addBooleanProperty(String, Boolean)

addDataProperty(String, Type)

addDataProperty(String, Type, Object)

addDateTimeProperty(String, Duration)

addDurationProperty(String, Duration)

addIntegerProperty(String, Integer)

addParagraphProperty(String, Paragraph)

addProperty(Property)

addReadOnlyProperty(String, Type)

addReference(Referrer)

Called to tell the atom thats its being referenced by the referrer.

addReferenceProperty(String, Type)

addReferenceProperty(String, Type, Atom)

addStringProperty(String, String)

argument(String)

This method should be overridden if this command takes arguments.

aspect()

An atoms aspect is what you see when you look at it

assignInitialOwner()

Sets the owner to a player (if this is being executed as a player, or as null, otherwise

canSwap()

containsAction(Action)

Returns true if the action is supported by this class.

dispose()

This is a method that should be called only once.

evalReadOnlyProperty(ReadOnlyProperty)

override to return the correct value for the supplied property make sure you call super.evalReadOnlyProperty if you don't understand it before returning null

finaliseSymbol(Object, StringTokenizer, boolean)

Takes a matched symbol.

finalize()

fullResolve()

getAction(String)

Returns the action corresponding to the supplied name.

getActions()

Returns a list of the actions supported by this class.

getAllProperties()

getHasParent()

getId()

getKey()

getName()

getOwner()

getOwnerTag()

getParent()

getPermissionList()

getProperty(String)

Local search only - won't step into properties even if you put .'s inside the id

getSymbol(String)

Full search for the symbol of id s.

getSymbol(StringTokenizer, boolean)

Internal use - returns a partially resolved symbol.

getSymbolTag(String)

Full search for the symbol of id s.

getTag()

getThroughSymbol(StringTokenizer, boolean)

This is called internally.

getTotalAtoms()

help()

Returns *class* help about this atom.

isLoading()

isOwner(Atom)

Returns true if potential owns this atom (either directly or indirectly)

isSymbolTransit(String)

loadFrom(DataInput)

newAction(Collection, String, boolean)

Adds another action to the available actions in the collection provided.

noLongerOwning(Atom)

nowOwning(Atom)

partialLoad()

references()

removeReference(Referrer)

resolve()

setKey(Object)

setOwner(Atom)

setParent(Parent)

This routine not only sets the parent, but ensures that this atom is removed from its previous parent, as well.

setProperty(DataProperty, Object)

setProperty(ReferenceProperty, Object)

setProperty(String, Object)

setPropertyId(ReferenceProperty, String)

setSymbol(String, Object)

setTag(Tag)

splash(Effect, SuppressionList)

When an effect occurs, people within its "splash" range are notified (that is, they can choose to notice or ignore it).

swapout()

Similar to dispose(), the swapout() method prepares a Atom to be swapped out non-destructively You should probably sync() before doing this...

sync()

toString()

writeTo(DataOutput)

 protected Collection allProperties

 protected ReadOnlyProperty nameProperty

 protected ReadOnlyProperty parentProperty

 protected ReadOnlyProperty ownerProperty

 protected ReadOnlyProperty idProperty

 protected ReadOnlyProperty referenceCountProperty

 protected PermissionList permissionList

 protected Tag owner

 protected String ownerId

 protected static StringKeyCollection staticActions

The list of actions for Atom's. Each sub-class that wants to have its own possible actions will need to have their own collection, as well as override the routines getActions(), containsAction(), and getAction().

 protected static Action moveAction

is allowed to change the parent of this atom - ie, move it around.

 protected static Action modifyAction

is allowed to modify the properties of this atom.

 protected static Action possessAction

is allowed to setOwnership of this atom.

 protected static Action deleteAction

is allowed to remove this atom from its parent

 public Atom()

 protected void assignInitialOwner()

Sets the owner to a player (if this is being executed as a player, or as null, otherwise

 public void argument(String args) throws IllegalArgumentException

This method should be overridden if this command takes arguments.

 public void addReference(Referrer r)

Called to tell the atom thats its being referenced by the referrer.

 public void removeReference(Referrer r)

 public final Enumeration references()

 public final void setKey(Object newkey)

 public final String getName()

 public final Object getKey()

 public final synchronized void setParent(Parent newParent)

This routine not only sets the parent, but ensures that this atom is removed from its previous parent, as well.

 public final Parent getParent()

 public final HasParent getHasParent()

 public final synchronized void setOwner(Atom newOwner)

 public boolean isOwner(Atom potential)

Returns true if potential owns this atom (either directly or indirectly)

 public final Atom getOwner()

 public final Tag getOwnerTag()

 protected final void noLongerOwning(Atom a)

 protected final void nowOwning(Atom a)

 public final Object getProperty(String id) throws NoSuchPropertyException

Local search only - won't step into properties even if you put .'s inside the id

 public Object evalReadOnlyProperty(ReadOnlyProperty p)

override to return the correct value for the supplied property make sure you call super.evalReadOnlyProperty if you don't understand it before returning null

 public final void setProperty(String id,
                               Object value) throws NoSuchPropertyException, TypeMismatchException

 protected final void setProperty(DataProperty p,
                                  Object value) throws NoSuchPropertyException, TypeMismatchException

 protected final void setProperty(ReferenceProperty p,
                                  Object value) throws NoSuchPropertyException, TypeMismatchException

 protected final void setPropertyId(ReferenceProperty p,
                                    String id)

 public final Object getSymbolTag(String s)

Full search for the symbol of id s. Will step into properties if you supply '.'s etc

Returns:

atom, the contents of a property, or null

 public Object getSymbol(String s)

Full search for the symbol of id s. Will step into properties if you supply '.'s etc

Returns:

atom, the contents of a property, or null

 public final boolean isSymbolTransit(String s)

 protected Object getThroughSymbol(StringTokenizer st,
                                   boolean resolveTags)

This is called internally. It is very similar to getSymbol, except that it won't evaluate a normal property (it'll still evaluate a ROProperty. This is useful, sometimes, say in setSymbol, where we want the property, as opposed to its value. In setSymbol, if its a ReadOnlyProperty, we can't touch it anyway, so blah, y'know?

 public final void setSymbol(String s,
                             Object value)

 protected Object getSymbol(StringTokenizer st,
                            boolean resolveTags)

Internal use - returns a partially resolved symbol. This function requires that it is passed a stringtokenizer containing elements like:

• /
• sym
• .
• anotherSym

if the tokenizer doesn't start with a . it is assumed (but only one)

Returns:

atom, a property, or null

 protected Object finaliseSymbol(Object o,
                                 StringTokenizer st,
                                 boolean resolveTags)

Takes a matched symbol. If its a property and there are more symbols following it, we can't tell the property to resolve the remainder for us, we have to resolve the property reference and then check what is matched. If what's matched is an atom or a cached atom, we should tell it to resolve the remainder of the references. otherwise, step

 public final Enumeration getAllProperties()

 public synchronized void swapout()

Similar to dispose(), the swapout() method prepares a Atom to be swapped out non-destructively You should probably sync() before doing this...

 public boolean canSwap()

 public synchronized void dispose()

This is a method that should be called only once. It forces the atom to remove all traces of itself from the program. If a way of referencing this atom is added (any reference to this atom is stored and the reverseReferences technique is *not* used, code to clear these references must be added here. This behaviour is essential for cached atoms, such as the player class (and all its derivative classes - such as the friend scape) when the player disconnects. If you want to store&destroy the object, thats exactly what you have to do. You can't dispose() and *then* write it, you must write it out and then dispose it when you're finished with it. dispose() does not guarantee that there is anything useable left in the class.

 public final Tag getTag()

 public void sync() throws IOException

 public final synchronized void setTag(Tag newTag)

 public synchronized void writeTo(DataOutput to) throws IOException

 public synchronized void partialLoad()

 public final boolean isLoading()

 public synchronized void loadFrom(DataInput from) throws IOException

 protected final Property addProperty(Property p)

 protected final DataProperty addBooleanProperty(String name,
                                                 Boolean value)

 protected final DataProperty addIntegerProperty(String name,
                                                 Integer value)

 protected final DataProperty addStringProperty(String name,
                                                String value)

 protected final DataProperty addParagraphProperty(String name,
                                                   Paragraph value)

 protected final DataProperty addDurationProperty(String name,
                                                  Duration value)

 protected final DataProperty addDateTimeProperty(String name,
                                                  Duration value)

 protected final ReadOnlyProperty addReadOnlyProperty(String name,
                                                      Type type)

 protected final ReferenceProperty addReferenceProperty(String name,
                                                        Type type)

 protected final ReferenceProperty addReferenceProperty(String name,
                                                        Type type,
                                                        Atom dflt)

 protected final AtomicProperty addAtomicProperty(String name,
                                                  Type type)

 protected final AtomicProperty addAtomicProperty(String name,
                                                  Type type,
                                                  Atom value)

 protected final DataProperty addDataProperty(String name,
                                              Type type)

 protected final DataProperty addDataProperty(String name,
                                              Type type,
                                              Object value)

 public String getId()

 public void resolve()

 public synchronized void fullResolve()

 public String toString()

Overrides:

toString in class Object

 public void splash(Effect e,
                    SuppressionList s)

When an effect occurs, people within its "splash" range are notified (that is, they can choose to notice or ignore it). This routine defaults to ignoring any effect, but you may override it at will to recieve any effect that it recieves.

 public Paragraph aspect()

An atoms aspect is what you see when you look at it

 public Paragraph help()

Returns *class* help about this atom. That is, help on the properties that are available to be set on this atom. Ideally, for every type of atom created this would be overridden (added to) so that help could be recieved on every property of an atom

 public final PermissionList getPermissionList()

 public Enumeration getActions()

Returns a list of the actions supported by this class. This routine will need to be overridden by sub-classes using actions

 public boolean containsAction(Action a)

Returns true if the action is supported by this class. This routine will need to be overridden by sub-classes using actions

 public Action getAction(String name)

Returns the action corresponding to the supplied name. This routine will need to be overriden by sub-classes using actions.

 protected static final Action newAction(Collection actions,
                                         String name,
                                         boolean expert)

Adds another action to the available actions in the collection provided.

 public static int getTotalAtoms()

 protected void finalize() throws Throwable

Overrides:

finalize in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index