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

Method Detail

newArchetypeAttributeAnimname

@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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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