Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.metacosm.util
Class AbsoluteModifier  view AbsoluteModifier download AbsoluteModifier.java

java.lang.Object
  extended byorg.metacosm.util.AbsoluteModifier
All Implemented Interfaces:
org.metacosm.framework.persistence.Persistent, java.io.Serializable
Direct Known Subclasses:
RandomAbsoluteModifier

public class AbsoluteModifier
extends java.lang.Object
implements org.metacosm.framework.persistence.Persistent

An AbsoluteModifier affects a new value to a Property. The initial value doesn't care (it would be a RelativeModifier in this case). AbsoluteModifiers are applied by priority order (i.e. only the first max priority AbsoluteModifier is applied).


Field Summary
static int MAX_PRIORITY
          Maximal priority
static int MIN_PRIORITY
          Minimal priority
static int NORMAL_PRIORITY
          Normal priority
protected  int priority
           
private  java.lang.Object value
           
 
Constructor Summary
(package private) AbsoluteModifier()
          Constructor for RandomAbsoluteModifier (no value)
  AbsoluteModifier(java.lang.Object value)
           
  AbsoluteModifier(java.lang.Object value, int priority)
           
 
Method Summary
 int getPriority()
           
 java.lang.Object getValue()
           
 void load(java.io.InputStream is)
          Loads from the stream.
 void save(java.io.OutputStream os)
          Saves on the stream.
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MIN_PRIORITY

public static final int MIN_PRIORITY
Minimal priority

See Also:
Constant Field Values

NORMAL_PRIORITY

public static final int NORMAL_PRIORITY
Normal priority

See Also:
Constant Field Values

MAX_PRIORITY

public static final int MAX_PRIORITY
Maximal priority

See Also:
Constant Field Values

value

private java.lang.Object value

priority

protected int priority
Constructor Detail

AbsoluteModifier

public AbsoluteModifier(java.lang.Object value,
                        int priority)
                 throws java.lang.IllegalArgumentException

AbsoluteModifier

public AbsoluteModifier(java.lang.Object value)
                 throws java.lang.IllegalArgumentException

AbsoluteModifier

AbsoluteModifier()
Constructor for RandomAbsoluteModifier (no value)

Method Detail

getValue

public java.lang.Object getValue()

getPriority

public final int getPriority()

save

public final void save(java.io.OutputStream os)
                throws java.io.IOException
Description copied from interface: org.metacosm.framework.persistence.Persistent
Saves on the stream.

Specified by:
save in interface org.metacosm.framework.persistence.Persistent

load

public void load(java.io.InputStream is)
          throws java.io.IOException
Description copied from interface: org.metacosm.framework.persistence.Persistent
Loads from the stream.

Specified by:
load in interface org.metacosm.framework.persistence.Persistent

toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).