Class StructureDefinition.Builder<T>
- java.lang.Object
-
- com.gtnewhorizon.structurelib.structure.StructureDefinition.Builder<T>
-
- Enclosing class:
- StructureDefinition<T>
public static class StructureDefinition.Builder<T> extends java.lang.Object
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description StructureDefinition.Builder<T>addElement(char name, IStructureElement<T> structurePiece)StructureDefinition.Builder<T>addElement(java.lang.Character name, IStructureElement<T> structurePiece)Deprecated.use the unboxed versionStructureDefinition.Builder<T>addShape(java.lang.String name, java.lang.String[][] structurePiece)Adds shape.StructureDefinition.Builder<T>addSocket(char name)LikeaddSocket(char, char)but without the replacement.StructureDefinition.Builder<T>addSocket(char name, char replacement)Denotesnameas a socket.IStructureDefinition<T>build()java.util.Map<java.lang.Character,IStructureElement<T>>getElements()java.util.Map<java.lang.String,java.lang.String>getShapes()
-
-
-
Method Detail
-
getElements
public java.util.Map<java.lang.Character,IStructureElement<T>> getElements()
-
getShapes
public java.util.Map<java.lang.String,java.lang.String> getShapes()
-
addShape
public StructureDefinition.Builder<T> addShape(java.lang.String name, java.lang.String[][] structurePiece)
Adds shape. Shape is a two-dimensional string array. Each character inside any of these strings will be later mapped to a particular type ofIStructureElementas indicated byaddElement(Character, IStructureElement).next char is next block(a) next string is next line(b) next string[] is next slice(c)
There are a few special reserved characters that are pre-mapped to some common structure elements
- + is anything but air
- - is air checks
- space bar is skip
- ~ is also skip (but marks controller position, not optional)
- char
A000-FFFFrange is reserved for generated skips
- Parameters:
name- unlocalized/code namestructurePiece- generated or written struct - DO NOT STORE IT ANYWHERE, or at least set them to null afterwards- Returns:
- this builder
-
addElement
@Deprecated public StructureDefinition.Builder<T> addElement(java.lang.Character name, IStructureElement<T> structurePiece)
Deprecated.use the unboxed version
-
addElement
public StructureDefinition.Builder<T> addElement(char name, IStructureElement<T> structurePiece)
-
addSocket
public StructureDefinition.Builder<T> addSocket(char name, char replacement)
Denotesnameas a socket. Sockets are virtual structure elements that record their position in the structure for future retrieval. They are transformed into real structure elements and do not need their own element (seereplacement).- Parameters:
name- The socket name characterreplacement- The replacement character- See Also:
IStructureDefinition.getSocket(String, char),IStructureDefinition.getAllSockets(String, char)
-
addSocket
public StructureDefinition.Builder<T> addSocket(char name)
LikeaddSocket(char, char)but without the replacement. The structure must have a structure element with the given character.- Parameters:
name- The socket name character
-
build
public IStructureDefinition<T> build()
-
-