net.sf.gridarta.model.archetypetype

Interface ArchetypeAttributeFactory

All Known Implementing Classes:

DefaultArchetypeAttributeFactory

public interface ArchetypeAttributeFactory

Interface for classes implementing ArchetypeAttribute factories.

Method Summary

Modifier and Type	Method and Description
@NotNull ArchetypeAttribute	newArchetypeAttributeAnimname(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "animname" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeBitmask(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength, @NotNull java.lang.String bitmaskName) Creates a new "bitmask" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeBool(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "bool" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeBoolSpec(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength, @NotNull java.lang.String trueValue, @NotNull java.lang.String falseValue) Creates a new "bool spec" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeFacename(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "face name" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeFixed(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "fixed" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeFloat(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "float" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeInt(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength, int minValue, int maxValue, int minCheckValue, int maxCheckValue) Creates a new "int" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeInvSpell(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "inv spell" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeInvSpellOptional(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "inv spell optional" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeList(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength, @NotNull java.lang.String listName) Creates a new "list" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeList2(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength, @NotNull java.lang.String listName1, @NotNull java.lang.String listName2) Creates a new "list2" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeLong(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "long" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeMapPath(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "map path" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeScriptFile(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "script file" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeSpell(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "spell" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeString(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "string" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeText(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String endingOld, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength, @Nullable java.lang.String fileExtension) Creates a new "text" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeTreasure(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "treasure" archetype attribute.
@NotNull ArchetypeAttribute	newArchetypeAttributeZSpell(@NotNull java.lang.String archetypeAttributeName, @NotNull java.lang.String attributeName, @NotNull java.lang.String description, int inputLength) Creates a new "z-spell" archetype attribute.

Method Detail

newArchetypeAttributeAnimname

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeAnimname(@NotNull
                                                                   @NotNull java.lang.String archetypeAttributeName,
                                                                   @NotNull
                                                                   @NotNull java.lang.String attributeName,
                                                                   @NotNull
                                                                   @NotNull java.lang.String description,
                                                                   int inputLength)

Creates a new "animname" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the archetype attribute

newArchetypeAttributeBitmask

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeBitmask(@NotNull
                                                                  @NotNull java.lang.String archetypeAttributeName,
                                                                  @NotNull
                                                                  @NotNull java.lang.String attributeName,
                                                                  @NotNull
                                                                  @NotNull java.lang.String description,
                                                                  int inputLength,
                                                                  @NotNull
                                                                  @NotNull java.lang.String bitmaskName)

Creates a new "bitmask" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

bitmaskName - the bitmask name

Returns:

the bitmask attribute

newArchetypeAttributeBool

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeBool(@NotNull
                                                               @NotNull java.lang.String archetypeAttributeName,
                                                               @NotNull
                                                               @NotNull java.lang.String attributeName,
                                                               @NotNull
                                                               @NotNull java.lang.String description,
                                                               int inputLength)

Creates a new "bool" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the bitmask attribute

newArchetypeAttributeBoolSpec

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeBoolSpec(@NotNull
                                                                   @NotNull java.lang.String archetypeAttributeName,
                                                                   @NotNull
                                                                   @NotNull java.lang.String attributeName,
                                                                   @NotNull
                                                                   @NotNull java.lang.String description,
                                                                   int inputLength,
                                                                   @NotNull
                                                                   @NotNull java.lang.String trueValue,
                                                                   @NotNull
                                                                   @NotNull java.lang.String falseValue)

Creates a new "bool spec" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

trueValue - the true value

falseValue - the false value

Returns:

the bitmask attribute

newArchetypeAttributeFacename

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeFacename(@NotNull
                                                                   @NotNull java.lang.String archetypeAttributeName,
                                                                   @NotNull
                                                                   @NotNull java.lang.String attributeName,
                                                                   @NotNull
                                                                   @NotNull java.lang.String description,
                                                                   int inputLength)

Creates a new "face name" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the bitmask attribute

newArchetypeAttributeFixed

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeFixed(@NotNull
                                                                @NotNull java.lang.String archetypeAttributeName,
                                                                @NotNull
                                                                @NotNull java.lang.String attributeName,
                                                                @NotNull
                                                                @NotNull java.lang.String description,
                                                                int inputLength)

Creates a new "fixed" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the bitmask attribute

newArchetypeAttributeFloat

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeFloat(@NotNull
                                                                @NotNull java.lang.String archetypeAttributeName,
                                                                @NotNull
                                                                @NotNull java.lang.String attributeName,
                                                                @NotNull
                                                                @NotNull java.lang.String description,
                                                                int inputLength)

Creates a new "float" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the bitmask attribute

newArchetypeAttributeInt

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeInt(@NotNull
                                                              @NotNull java.lang.String archetypeAttributeName,
                                                              @NotNull
                                                              @NotNull java.lang.String attributeName,
                                                              @NotNull
                                                              @NotNull java.lang.String description,
                                                              int inputLength,
                                                              int minValue,
                                                              int maxValue,
                                                              int minCheckValue,
                                                              int maxCheckValue)

Creates a new "int" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

minValue - the absolute minimum allowed value

maxValue - the absolute maximum allowed value

minCheckValue - the logical minimum allowed value

maxCheckValue - the logical maximum allowed value

Returns:

the bitmask attribute

newArchetypeAttributeInvSpell

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeInvSpell(@NotNull
                                                                   @NotNull java.lang.String archetypeAttributeName,
                                                                   @NotNull
                                                                   @NotNull java.lang.String attributeName,
                                                                   @NotNull
                                                                   @NotNull java.lang.String description,
                                                                   int inputLength)

Creates a new "inv spell" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the bitmask attribute

newArchetypeAttributeInvSpellOptional

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeInvSpellOptional(@NotNull
                                                                           @NotNull java.lang.String archetypeAttributeName,
                                                                           @NotNull
                                                                           @NotNull java.lang.String attributeName,
                                                                           @NotNull
                                                                           @NotNull java.lang.String description,
                                                                           int inputLength)

Creates a new "inv spell optional" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the bitmask attribute

newArchetypeAttributeList

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeList(@NotNull
                                                               @NotNull java.lang.String archetypeAttributeName,
                                                               @NotNull
                                                               @NotNull java.lang.String attributeName,
                                                               @NotNull
                                                               @NotNull java.lang.String description,
                                                               int inputLength,
                                                               @NotNull
                                                               @NotNull java.lang.String listName)

Creates a new "list" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

listName - the list name

Returns:

the bitmask attribute

newArchetypeAttributeList2

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeList2(@NotNull
                                                                @NotNull java.lang.String archetypeAttributeName,
                                                                @NotNull
                                                                @NotNull java.lang.String attributeName,
                                                                @NotNull
                                                                @NotNull java.lang.String description,
                                                                int inputLength,
                                                                @NotNull
                                                                @NotNull java.lang.String listName1,
                                                                @NotNull
                                                                @NotNull java.lang.String listName2)

Creates a new "list2" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

listName1 - the list name for bits 0-3

listName2 - the list name for bits 4+

Returns:

the bitmask attribute

newArchetypeAttributeLong

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeLong(@NotNull
                                                               @NotNull java.lang.String archetypeAttributeName,
                                                               @NotNull
                                                               @NotNull java.lang.String attributeName,
                                                               @NotNull
                                                               @NotNull java.lang.String description,
                                                               int inputLength)

Creates a new "long" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the bitmask attribute

newArchetypeAttributeMapPath

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeMapPath(@NotNull
                                                                  @NotNull java.lang.String archetypeAttributeName,
                                                                  @NotNull
                                                                  @NotNull java.lang.String attributeName,
                                                                  @NotNull
                                                                  @NotNull java.lang.String description,
                                                                  int inputLength)

Creates a new "map path" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the bitmask attribute

newArchetypeAttributeScriptFile

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeScriptFile(@NotNull
                                                                     @NotNull java.lang.String archetypeAttributeName,
                                                                     @NotNull
                                                                     @NotNull java.lang.String attributeName,
                                                                     @NotNull
                                                                     @NotNull java.lang.String description,
                                                                     int inputLength)

Creates a new "script file" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the bitmask attribute

newArchetypeAttributeSpell

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeSpell(@NotNull
                                                                @NotNull java.lang.String archetypeAttributeName,
                                                                @NotNull
                                                                @NotNull java.lang.String attributeName,
                                                                @NotNull
                                                                @NotNull java.lang.String description,
                                                                int inputLength)

Creates a new "spell" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the bitmask attribute

newArchetypeAttributeString

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeString(@NotNull
                                                                 @NotNull java.lang.String archetypeAttributeName,
                                                                 @NotNull
                                                                 @NotNull java.lang.String attributeName,
                                                                 @NotNull
                                                                 @NotNull java.lang.String description,
                                                                 int inputLength)

Creates a new "string" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the bitmask attribute

newArchetypeAttributeText

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeText(@NotNull
                                                               @NotNull java.lang.String archetypeAttributeName,
                                                               @NotNull
                                                               @NotNull java.lang.String endingOld,
                                                               @NotNull
                                                               @NotNull java.lang.String attributeName,
                                                               @NotNull
                                                               @NotNull java.lang.String description,
                                                               int inputLength,
                                                               @Nullable
                                                               @Nullable java.lang.String fileExtension)

Creates a new "text" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

endingOld - the terminating string

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

fileExtension - the file extension

Returns:

the bitmask attribute

newArchetypeAttributeTreasure

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeTreasure(@NotNull
                                                                   @NotNull java.lang.String archetypeAttributeName,
                                                                   @NotNull
                                                                   @NotNull java.lang.String attributeName,
                                                                   @NotNull
                                                                   @NotNull java.lang.String description,
                                                                   int inputLength)

Creates a new "treasure" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the bitmask attribute

newArchetypeAttributeZSpell

@NotNull
@NotNull ArchetypeAttribute newArchetypeAttributeZSpell(@NotNull
                                                                 @NotNull java.lang.String archetypeAttributeName,
                                                                 @NotNull
                                                                 @NotNull java.lang.String attributeName,
                                                                 @NotNull
                                                                 @NotNull java.lang.String description,
                                                                 int inputLength)

Creates a new "z-spell" archetype attribute.

Parameters:

archetypeAttributeName - the archetype attribute name

attributeName - the user interface attribute name

description - the attribute's description

inputLength - the input length in characters for text input fields

Returns:

the bitmask attribute