java.lang.Object
- net.sf.gridarta.model.archetypeset.DefaultArchetypeSet<G,A,R>

All Implemented Interfaces:: ArchetypeSet<G,A,R>

public class DefaultArchetypeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object
implements ArchetypeSet<G,A,R>

Base implementation of ArchetypeSet.

Constructor Summary

Constructors
Constructor	Description
`DefaultArchetypeSet(@NotNull ArchetypeFactory<G,A,R> archetypeFactory, @Nullable java.lang.String imageSet)`	Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addArchetype(R archetype)`	Adds an Archetype to this Set.
`void`	`addArchetypeSetListener(@NotNull ArchetypeSetListener<G,A,R> listener)`	Registers an ArchetypeSetListener.
`void`	`connectFaces()`
`R`	`getArchetype(@NotNull java.lang.String archetypeName)`	Returns an Archetype by its name.
`int`	`getArchetypeCount()`	Returns the number of Archetypes available.
`@NotNull java.util.Collection<R>`	`getArchetypes()`	Returns a read-only collection of all `Archetypes`.
`@Nullable java.lang.String`	`getImageSet()`	Returns the image set.
`R`	`getOrCreateArchetype(@NotNull java.lang.String archetypeName)`	Returns an archetype by its name.
`boolean`	`isLoadedFromArchive()`	Returns whether the Archetypes in this ArchetypeSet were loaded from an archive.
`void`	`removeArchetypeSetListener(@NotNull ArchetypeSetListener<G,A,R> listener)`	Removes an `ArchetypeSetListener`.
`void`	`setLoadedFromArchive(boolean loadedFromArchive)`	Sets whether Archetypes were loaded from an archive.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultArchetypeSet
```
public DefaultArchetypeSet(@NotNull
                           @NotNull ArchetypeFactory<G,A,R> archetypeFactory,
                           @Nullable
                           @Nullable java.lang.String imageSet)
```
    Creates a new instance.
    
    Parameters:
    
    archetypeFactory - the archetype factory to use
    
    imageSet - the image set to use
- Method Detail
  - getImageSet
```
@Nullable
public @Nullable java.lang.String getImageSet()
```
    Description copied from interface: ArchetypeSet
    
    Returns the image set.
    
    Specified by:
    
    getImageSet in interface ArchetypeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the image set or null
  - isLoadedFromArchive
```
public boolean isLoadedFromArchive()
```
    Description copied from interface: ArchetypeSet
    
    Returns whether the Archetypes in this ArchetypeSet were loaded from an archive.
    
    Specified by:
    
    isLoadedFromArchive in interface ArchetypeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    true if loaded from an archive, otherwise false
  - getArchetypeCount
```
public int getArchetypeCount()
```
    Description copied from interface: ArchetypeSet
    
    Returns the number of Archetypes available.
    
    Specified by:
    
    getArchetypeCount in interface ArchetypeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    the number of Archetypes available
  - getArchetype
```
@NotNull
public R getArchetype(@NotNull
                      @NotNull java.lang.String archetypeName)
               throws UndefinedArchetypeException
```
    Description copied from interface: ArchetypeSet
    
    Returns an Archetype by its name.
    
    Specified by:
    
    getArchetype in interface ArchetypeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    archetypeName - the name of the Archetype to get
    
    Returns:
    
    the archetype
    
    Throws:
    
    UndefinedArchetypeException - if the no such archetype exists
    
    See Also:
    
    for a similar method that creates undefined archetypes
  - getOrCreateArchetype
```
@NotNull
public R getOrCreateArchetype(@NotNull
                              @NotNull java.lang.String archetypeName)
```
    Description copied from interface: ArchetypeSet
    
    Returns an archetype by its name. If this archetype does not exist, return an Archetype which has Archetype.isUndefinedArchetype() set.
    
    Specified by:
    
    getOrCreateArchetype in interface ArchetypeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    archetypeName - the archetype name
    
    Returns:
    
    the archetype
    
    See Also:
    
    ArchetypeSet.getArchetype(String)
  - addArchetype
```
public void addArchetype(@NotNull
                         R archetype)
                  throws DuplicateArchetypeException
```
    Description copied from interface: ArchetypeSet
    
    Adds an Archetype to this Set.
    
    Specified by:
    
    addArchetype in interface ArchetypeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    archetype - the archetype to add
    
    Throws:
    
    DuplicateArchetypeException - if the archetype name is not unique
  - setLoadedFromArchive
```
public void setLoadedFromArchive(boolean loadedFromArchive)
```
    Description copied from interface: ArchetypeSet
    
    Sets whether Archetypes were loaded from an archive.
    
    Specified by:
    
    setLoadedFromArchive in interface ArchetypeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    loadedFromArchive - true when loaded from archive, otherwise false
    
    See Also:
    
    ArchetypeSet.isLoadedFromArchive()
  - getArchetypes
```
@NotNull
public @NotNull java.util.Collection<R> getArchetypes()
```
    Description copied from interface: ArchetypeSet
    
    Returns a read-only collection of all Archetypes.
    
    Specified by:
    
    getArchetypes in interface ArchetypeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Returns:
    
    a read-only collection of all archetypes
  - addArchetypeSetListener
```
public void addArchetypeSetListener(@NotNull
                                    @NotNull ArchetypeSetListener<G,A,R> listener)
```
    Registers an ArchetypeSetListener.
    
    Specified by:
    
    addArchetypeSetListener in interface ArchetypeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    listener - ArchetypeSetListener to register
  - removeArchetypeSetListener
```
public void removeArchetypeSetListener(@NotNull
                                       @NotNull ArchetypeSetListener<G,A,R> listener)
```
    Description copied from interface: ArchetypeSet
    
    Removes an ArchetypeSetListener.
    
    Specified by:
    
    removeArchetypeSetListener in interface ArchetypeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
    
    Parameters:
    
    listener - the listener to remove
  - connectFaces
```
public void connectFaces()
```
    Specified by:
    
    connectFaces in interface ArchetypeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Class DefaultArchetypeSet<G extends GameObject<G,​A,​R>,​A extends MapArchObject<A>,​R extends Archetype<G,​A,​R>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultArchetypeSet

Method Detail

getImageSet

isLoadedFromArchive

getArchetypeCount

getArchetype

getOrCreateArchetype

addArchetype

setLoadedFromArchive

getArchetypes

addArchetypeSetListener

removeArchetypeSetListener

connectFaces

Class DefaultArchetypeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>