|
OGS Java API Spec | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--ogs.core.Size
The overall size of an entity falls into one of nine categories.
Field Summary | |
static char |
COLLOSAL
As big as a tall building. |
static char |
DIMINUITIVE
Small enough to hold one in your hand. |
static char |
FINE
Small enough to hold dozens in one hand. |
static char |
GARGANTUAN
As big as a house. |
static char |
HUGE
As big as a tree. |
static char |
LARGE
Slightly larger than an average human. |
static char |
MEDIUM
Roughly the size of an average human. |
static char |
SMALL
Small enough to hold in both arms. |
static char |
TINY
Small enough to hold in both hands. |
Constructor Summary | |
Size()
Creates a medium entity size. |
|
Size(char size)
Creates a specified entity size. |
Method Summary | |
int |
compareTo(Object object)
Compare this size to another size. |
int |
compareTo(Size s)
Compare this size to another size. |
Modifier |
getModifier()
Determine the modifier of the current size category. |
char |
getSize()
Determine the current size category. |
void |
setSize(char size)
Change the current size category. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final char FINE
public static final char DIMINUITIVE
public static final char TINY
public static final char SMALL
public static final char MEDIUM
public static final char LARGE
public static final char HUGE
public static final char GARGANTUAN
public static final char COLLOSAL
Constructor Detail |
public Size()
public Size(char size)
size
- One of the predefined sizes.Method Detail |
public char getSize()
public void setSize(char size)
size
- One of the predefined sizes.
IllegalArgumentException
- If size is invalid.public Modifier getModifier()
public int compareTo(Object object)
Size
object.
compareTo
in interface Comparable
public int compareTo(Size s)
|
OGS Java API Spec | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |