io.github.portlek.smartinventory.util

Class Pattern<T>

java.lang.Object

io.github.portlek.smartinventory.util.Pattern<T>

Type Parameters:

T - the type of the values that will be associated with the character keys.

public final class Pattern<T>
extends Object

a class representing a pattern with arbitrary keys and values.

Constructor Summary

Constructors

Constructor and Description
Pattern(boolean wrapAround, String... lines) ctor.
Pattern(String... lines) ctor.

Method Summary

Modifier and Type	Method and Description
@NotNull Pattern<T>	attach(char character, T object) attaches an object to a character in this pattern instance.
@NotNull List<SlotPos>	findAllKeys(char character) searches through this patterns lines to find all occurrences of this key.
@NotNull Optional<SlotPos>	findKey(char character) searches through this patterns lines to find the first top-left occurrence of this key.
int	getColumnCount() this method counts the amount of rows this pattern has based on the length of the lines.
@NotNull Optional<T>	getDefaultValue() returns the default value set via setDefault(Object)
@NotNull Optional<T>	getObject(int index) returns the object from the n-th key in this pattern.
@NotNull Optional<T>	getObject(int row, int column) retrieves the object associated with the key found at the row and column in this pattern, if there is no object attached to that character, the default object set via setDefault(Object) is used.
@NotNull Optional<T>	getObject(@NotNull SlotPos slot) this method is simple a shorthand to the method call getObject(slot.getRow(), slot.getColumn()), so all the special cases described in that method will apply to this one.
int	getRowCount() this method counts the amount of rows this pattern has based on the amount of lines provided at creation.
boolean	isWrapAround() a simple getter for the value provided at the Patterns creation, if this pattern supports wrapAround.
@NotNull Pattern<T>	setDefault(T defaultValue) sets a new default value, which can be null and will override the previous value if present.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pattern

public Pattern(@NotNull
               String... lines)

ctor.

Parameters:

lines - the lines describing the pattern.

Throws:

IllegalArgumentException - if the length of lines is zero.

IllegalArgumentException - if the length of a line is not equal to the length of the first line.

See Also:

to get the possibility to create a repeating pattern.

Pattern

public Pattern(boolean wrapAround,
               @NotNull
               String... lines)

ctor.

Parameters:

wrapAround - whether the pattern should be repeated if the.

lines - the lines describing the pattern.

Throws:

IllegalArgumentException - if the length of lines is zero

IllegalArgumentException - if the length of a line is not equal to the length of the first line

Method Detail

attach

@NotNull
public @NotNull Pattern<T> attach(char character,
                                           @NotNull
                                           T object)

attaches an object to a character in this pattern instance.

Parameters:

character - The key character.

object - The object to attach to that character.

Returns:

this for a builder-like usage.

getObject

@NotNull
public @NotNull Optional<T> getObject(int index)

returns the object from the n-th key in this pattern. if this pattern has wrapAround set to true, and the index is equals or greater than the amount of individual positions in this pattern, it will continue downwards, and not wrap around sideways. because of this, it could be unclear what this method does and usage is for code clarity discouraged.

Parameters:

index - The index in this pattern.

Returns:

The object associated with the key.

See Also:

For more detailed information.

getObject

@NotNull
public @NotNull Optional<T> getObject(@NotNull
                                               @NotNull SlotPos slot)

this method is simple a shorthand to the method call getObject(slot.getRow(), slot.getColumn()), so all the special cases described in that method will apply to this one.

Parameters:

slot - The slot position to extract the row and column from.

Returns:

The object associated with the key, or the default object.

See Also:

For the more detailed information.

getObject

@NotNull
public @NotNull Optional<T> getObject(int row,
                                               int column)

retrieves the object associated with the key found at the row and column in this pattern, if there is no object attached to that character, the default object set via setDefault(Object) is used.

if wrapAround is set to true and the row or column would be too big or small of the pattern, it will wrap around and continue on from the other side, like it would be endless. if not, IndexOutOfBoundsException will be thrown.

Parameters:

row - The row of the key.

column - The column of the key.

Returns:

The object associated with the key, or the default object.

Throws:

IndexOutOfBoundsException - if wrapAround is false and row or column are negative or not less that the patterns dimensions.

findKey

@NotNull
public @NotNull Optional<SlotPos> findKey(char character)

searches through this patterns lines to find the first top-left occurrence of this key. if it could not be found, the returned Optional is empty.

Parameters:

character - The character key to look for.

Returns:

an optional containing the slot position in this pattern, or empty if it could not be found.

findAllKeys

@NotNull
public @NotNull List<SlotPos> findAllKeys(char character)

searches through this patterns lines to find all occurrences of this key. the first position is the most top-left and the last position is the most bottom-right one.

if the key isn't contained in this pattern, the returned list will be empty.

Parameters:

character - The character key to look for.

Returns:

A mutable list containing all positions where that key occurs.

setDefault

@NotNull
public @NotNull Pattern<T> setDefault(@NotNull
                                               T defaultValue)

sets a new default value, which can be null and will override the previous value if present.

Parameters:

defaultValue - The new default value.

Returns:

this for a builder-like usage.

getDefaultValue

@NotNull
public @NotNull Optional<T> getDefaultValue()

returns the default value set via setDefault(Object)

Returns:

The default value.

getRowCount

public int getRowCount()

this method counts the amount of rows this pattern has based on the amount of lines provided at creation.

Returns:

the amount of rows.

getColumnCount

public int getColumnCount()

this method counts the amount of rows this pattern has based on the length of the lines.

Returns:

the amount of columns.

isWrapAround

public boolean isWrapAround()

a simple getter for the value provided at the Patterns creation, if this pattern supports wrapAround.

Returns:

true if wrapAround is enabled for this instance.