net.sf.gridarta.model.archetypetype

Class ArchetypeType

java.lang.Object

net.sf.gridarta.model.archetypetype.ArchetypeType

All Implemented Interfaces:

java.lang.Iterable<ArchetypeAttributeSection>

public class ArchetypeType
extends java.lang.Object
implements java.lang.Iterable<ArchetypeAttributeSection>

Contains the data of one Gridarta Object-Type. The data is read from a definitions file called 'types.xml'. It is mainly used as info-base for the arch-attribute GUI.

Constructor Summary

Constructors

Constructor and Description
ArchetypeType(java.lang.String typeName, int typeNo, java.lang.String display, boolean map, int[] inv, boolean allowsAllInv, java.lang.String description, java.lang.String use, ArchetypeAttributesDefinition typeAttributes) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addArchetypeAttribute(java.lang.String sectionName, ArchetypeAttribute archetypeAttribute) Adds an ArchetypeAttribute to this archetype type.
void	addAttributeSection(ArchetypeAttributeSection newArchetypeAttributeSection) Adds an ArchetypeAttributeSection.
java.lang.String	getDescription() Returns the description.
java.lang.String	getDisplayName(Attributes baseObject) Returns a description of this type.
int[]	getInv() Returns which archetype types allow this archetype type in their inventories.
java.lang.String	getTypeName() Returns the type name (artificial).
int	getTypeNo() Returns the type number.
java.lang.String	getUse() Returns the usage notes.
boolean	hasAttribute() Returns whether this archetype type defines at least one archetype attribute.
boolean	hasAttributeKey(java.lang.Comparable<java.lang.String> key) Returns whether an attribute key is defined.
boolean	hasTypeAttributes() Returns whether any type attributes are defined.
boolean	isAllowsAllInv() Returns whether this archetype type allows any inventory game objects, regardless whether these types have "inv" specifications.
boolean	isMap() Returns whether this archetype is allowed on maps.
java.util.Iterator<ArchetypeAttributeSection>	iterator()
boolean	matches(BaseObject<?,?,?,?> baseObject) Checks whether a BaseObject matches all type attributes.
java.lang.String	toString()
void	toString(java.lang.StringBuilder sb) Appends a string representation of this instance to a StringBuilder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ArchetypeType

public ArchetypeType(@NotNull
                     java.lang.String typeName,
                     int typeNo,
                     @NotNull
                     java.lang.String display,
                     boolean map,
                     @Nullable
                     int[] inv,
                     boolean allowsAllInv,
                     @Nullable
                     java.lang.String description,
                     @Nullable
                     java.lang.String use,
                     @NotNull
                     ArchetypeAttributesDefinition typeAttributes)

Creates a new instance.

Parameters:

typeName - the type name (artificial)

typeNo - the type number

display - additional description text

map - whether this archetype type is allowed on maps

inv - which archetype types allow this archetype type in their inventories or null for no restrictions

allowsAllInv - whether this archetype type allows any inventory game objects, whether these types have "inv" specifications

description - the description

use - the usage notes

typeAttributes - the list of additional attributes

Method Detail

addAttributeSection

public void addAttributeSection(@NotNull
                                ArchetypeAttributeSection newArchetypeAttributeSection)

Adds an ArchetypeAttributeSection. If the section already exists appends the new attributes to the existing section.

Parameters:

newArchetypeAttributeSection - the section to add

iterator

@NotNull
public java.util.Iterator<ArchetypeAttributeSection> iterator()

Specified by:

iterator in interface java.lang.Iterable<ArchetypeAttributeSection>

hasAttribute

public boolean hasAttribute()

Returns whether this archetype type defines at least one archetype attribute.

Returns:

whether at least one archetype attribute exists

getTypeNo

public int getTypeNo()

Returns the type number.

Returns:

the type number

getTypeName

@NotNull
public java.lang.String getTypeName()

Returns the type name (artificial).

Returns:

the type name

isMap

public boolean isMap()

Returns whether this archetype is allowed on maps.

Returns:

whether this archetype is allowed on maps

getInv

@Nullable
public int[] getInv()

Returns which archetype types allow this archetype type in their inventories.

Returns:

the allowed environment types or null for no restrictions

isAllowsAllInv

public boolean isAllowsAllInv()

Returns whether this archetype type allows any inventory game objects, regardless whether these types have "inv" specifications.

Returns:

whether this archetype type allows any inventory game objects

getDescription

@NotNull
public java.lang.String getDescription()

Returns the description.

Returns:

the description

getUse

@NotNull
public java.lang.String getUse()

Returns the usage notes.

Returns:

the usage notes

matches

public boolean matches(@NotNull
                       BaseObject<?,?,?,?> baseObject)

Checks whether a BaseObject matches all type attributes.

Parameters:

baseObject - the base object to check

Returns:

whether the base object matches

hasTypeAttributes

public boolean hasTypeAttributes()

Returns whether any type attributes are defined.

Returns:

whether any type attributes are defined

hasAttributeKey

public boolean hasAttributeKey(@NotNull
                               java.lang.Comparable<java.lang.String> key)

Returns whether an attribute key is defined.

Parameters:

key - the attribute key

Returns:

whether the attribute key is defined

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public void toString(@NotNull
                     java.lang.StringBuilder sb)

Appends a string representation of this instance to a StringBuilder.

Parameters:

sb - the string builder

getDisplayName

@NotNull
public java.lang.String getDisplayName(@NotNull
                                                Attributes baseObject)

Returns a description of this type.

Parameters:

baseObject - the base object to describe

Returns:

the description

addArchetypeAttribute

public void addArchetypeAttribute(@NotNull
                                  java.lang.String sectionName,
                                  @NotNull
                                  ArchetypeAttribute archetypeAttribute)

Adds an ArchetypeAttribute to this archetype type.

Parameters:

sectionName - the name of the section to add to

archetypeAttribute - the archetype attribute to add