CraftingGrid (NOVA-Core 0.1.0-SNAPSHOT API)

All Superinterfaces:

java.lang.Iterable<Item>

All Known Implementing Classes:

CraftingGridDummy
```
public interface CraftingGrid
extends java.lang.Iterable<Item>
```
Represents a crafting grid. Crafting grids contain an item in each slot, each of which can be read and possibly modified.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String TOPOLOGY_SQUARE

static java.lang.String TYPE_CRAFTING

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`TOPOLOGY_SQUARE`
`static java.lang.String`	`TYPE_CRAFTING`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default int`	`countFilledStacks()` Counts the number of filled the items in this crafting grid.
`java.util.Optional<Item>`	`getCrafting(int slot)` Gets the item in a specified slot.
`java.util.Optional<Item>`	`getCrafting(int x, int y)` Gets the item at the given (x, y) position.
`default java.util.Optional<Item>`	`getFirstNonEmptyItem()` Gets the first non-empty item in this crafting grid.
`default java.util.Optional<org.apache.commons.math3.geometry.euclidean.twod.Vector2D>`	`getFirstNonEmptyPosition()` Finds the position of the first non-empty the item in this crafting grid.
`int`	`getHeight()` Gets the height of the crafting grid.
`java.util.Optional<Player>`	`getPlayer()` Represents the player that is currently using this crafting grid.
`java.lang.String`	`getTopology()` Gets the topology of the crafting grid.
`java.lang.String`	`getType()` Gets the type of crafting grid.
`int`	`getWidth()` Gets the width of the crafting grid.
`default void`	`giveBack(Item item)` Gives back a certain item.
`default java.util.Iterator<Item>`	`iterator()`
`default java.util.Optional<Item>`	`removeCrafting(int slot)` Removes the item in a specified slot.
`default java.util.Optional<Item>`	`removeCrafting(int x, int y)` Removes the item at the given (x, y) position.
`boolean`	`setCrafting(int x, int y, java.util.Optional<Item> item)` Sets the item at the given (x, y) position.
`boolean`	`setCrafting(int slot, java.util.Optional<Item> item)` Modifies the item in the given slot.
`int`	`size()` Returns the total size of this crafting grid.
`default java.util.Spliterator<Item>`	`spliterator()`
`default java.util.stream.Stream<Item>`	`stream()` Represents this crafting grid as an `Item` `Stream`

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - TOPOLOGY_SQUARE
```
static final java.lang.String TOPOLOGY_SQUARE
```
    See Also:
    
    Constant Field Values
  - TYPE_CRAFTING
```
static final java.lang.String TYPE_CRAFTING
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getPlayer
```
java.util.Optional<Player> getPlayer()
```
    Represents the player that is currently using this crafting grid.
    
    Returns:
    
    crafting grid player
  - size
```
int size()
```
    Returns the total size of this crafting grid. For a square crafting grid, this is width x height. Note that the size can be less than width x height in the case of non-square crafting grid (but never more).
    
    Returns:
    
    The size
  - getCrafting
```
java.util.Optional<Item> getCrafting(int slot)
```
    Gets the item in a specified slot.
    
    Parameters:
    
    slot - slot index
    
    Returns:
    
    the item in the given slot
    
    See Also:
    
    getCrafting(int, int)
  - getCrafting
```
java.util.Optional<Item> getCrafting(int x,
                                     int y)
```
    Gets the item at the given (x, y) position. Returns an empty optional if there is no the item at that position.
    
    Parameters:
    
    x - x position
    
    y - y position
    
    Returns:
    
    the item at the given position
    
    See Also:
    
    getCrafting(int)
  - setCrafting
```
boolean setCrafting(int slot,
                    java.util.Optional<Item> item)
```
    Modifies the item in the given slot. If the modification is not possible, this method returns false. If modification was successful, returns true. Slots in a crafting grid should also be ordered with the slots at the y=0 first, starting from smallest x to largest x and then from smallest y to largest y (natural order). However, not all (x, y) positions need to have a corresponding slot.
    
    Parameters:
    
    slot - slot to be modified
    
    item - the item to be setCrafting
    
    Returns:
    
    true if modification was successful, false otherwise
    
    See Also:
    
    setCrafting(int, int, Optional)
  - setCrafting
```
boolean setCrafting(int x,
                    int y,
                    java.util.Optional<Item> item)
```
    Sets the item at the given (x, y) position.
    
    Parameters:
    
    x - x position
    
    y - y position
    
    item - the item to be setCrafting
    
    Returns:
    
    true if the modification is successful, false otherwise
    
    See Also:
    
    setCrafting(int, Optional)
  - removeCrafting
```
default java.util.Optional<Item> removeCrafting(int slot)
```
    Removes the item in a specified slot.
    
    Parameters:
    
    slot - slot index
    
    Returns:
    
    the previous item in the given slot
    
    See Also:
    
    removeCrafting(int, int)
  - removeCrafting
```
default java.util.Optional<Item> removeCrafting(int x,
                                                int y)
```
    Removes the item at the given (x, y) position.
    
    Parameters:
    
    x - x position
    
    y - y position
    
    Returns:
    
    the previous item at the position
    
    See Also:
    
    removeCrafting(int)
  - getWidth
```
int getWidth()
```
    Gets the width of the crafting grid. For a non-square grid,, this should return the highest acceptable x-value + 1.
    
    Returns:
    
    crafting grid width
  - getHeight
```
int getHeight()
```
    Gets the height of the crafting grid. For a non-square grid, this should return the highest acceptable y-value + 1.
    
    Returns:
    
    crafting grid height
  - giveBack
```
default void giveBack(Item item)
```
    Gives back a certain item. In the case of a player's crafting grid, this would typically go back to the player's inventory. Machines may implement this method differently.
    
    Parameters:
    
    item - The Item to give back.
  - getTopology
```
java.lang.String getTopology()
```
    Gets the topology of the crafting grid. For a square grid, this should be TOPOLOGY_SQUARE. Other kinds of grids may return a different value.
    
    Returns:
    
    crafting grid topology
  - getType
```
java.lang.String getType()
```
    Gets the type of crafting grid. For a crafting recipe, this should return TYPE_CRAFTING. Other machines or crafting tables (with a separate setCrafting of recipes) may return a different value.
    
    Returns:
    
    crafting grid type
  - countFilledStacks
```
default int countFilledStacks()
```
    Counts the number of filled the items in this crafting grid.
    
    Returns:
    
    number of non-empty the items in this crafting grid
  - getFirstNonEmptyItem
```
default java.util.Optional<Item> getFirstNonEmptyItem()
```
    Gets the first non-empty item in this crafting grid. Returns empty if and only if the crafting grid is completely empty.
    
    Returns:
    
    first non-empty item
  - getFirstNonEmptyPosition
```
default java.util.Optional<org.apache.commons.math3.geometry.euclidean.twod.Vector2D> getFirstNonEmptyPosition()
```
    Finds the position of the first non-empty the item in this crafting grid. Returns empty if and only if the crafting grid is completely empty.
    
    Returns:
    
    first non-empty item position
  - iterator
```
default java.util.Iterator<Item> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<Item>
  - spliterator
```
default java.util.Spliterator<Item> spliterator()
```
    Specified by:
    
    spliterator in interface java.lang.Iterable<Item>
  - stream
```
default java.util.stream.Stream<Item> stream()
```
    Represents this crafting grid as an Item Stream
    
    Returns:
    
    This crafting grid as an Item Stream

Interface CraftingGrid

Field Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Field Detail

TOPOLOGY_SQUARE

TYPE_CRAFTING

Method Detail

getPlayer

size

getCrafting

getCrafting

setCrafting

setCrafting

removeCrafting

removeCrafting

getWidth

getHeight

giveBack

getTopology

getType

countFilledStacks

getFirstNonEmptyItem

getFirstNonEmptyPosition

iterator

spliterator

stream