nova.core.component

Class SidedComponentMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.Class<? extends Component>,Component>

nova.core.component.ComponentMap

nova.core.component.SidedComponentMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Class<? extends Component>,Component>

public class SidedComponentMap
extends ComponentMap

A class that contains all sided components. This was implemented horribly poorly, so I intend to re‑implement it in a better way, which will also break backwards compatibility for the most part.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
ComponentMap	down
ComponentMap	east
ComponentMap	north
ComponentMap	south
ComponentMap	up
ComponentMap	west

Fields inherited from class nova.core.component.ComponentMap

provider

Constructor Summary

Constructors

Constructor and Description
SidedComponentMap(ComponentProvider<?> provider)

Method Summary

Modifier and Type	Method and Description
<C extends Component> C	add(C component, Direction... directions) Adds a component to the provider.
<C extends Component> C	add(C component, Direction direction) Adds a component to the provider.
<C extends Component> C	add(java.lang.Class<C> componentType, Direction... directions) Adds a new component based on its superclass or interface using dependency injection.
<C extends Component> C	add(java.lang.Class<C> componentType, Direction direction) Adds a new component based on its superclass or interface using dependency injection.
boolean	canRemove(java.lang.Class<?> componentType, Direction direction) Checks if a component type can be removed from this provider.
<C> C	get(java.lang.Class<C> componentType, Direction direction) Gets the component with the specified type.
ComponentMap	getComponents(Direction direction)
java.util.Map<Direction,ComponentMap>	getComponentsForDirections()
<C> java.util.Optional<C>	getOp(java.lang.Class<C> componentType, Direction direction) Gets an optional of the component with the specified type.
<C extends Component> C	getOrAdd(C component, Direction direction) Adds a component to the block if it is not present.
<C> java.util.Set<C>	getSet(java.lang.Class<C> componentType, Direction direction) Gets the set of the components with the specified type.
boolean	has(java.lang.Class<?> componentType, Direction direction) Checks if a component type exists in this provider.
<C extends Component> C	remove(C component, Direction direction) Removes the component from the block.
<C extends Component> C	remove(java.lang.Class<C> componentType, Direction direction) Removes the component from the provider.

Methods inherited from class nova.core.component.ComponentMap

add, add, get, getOp, getOrAdd, getSet, has, remove, remove

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

up

public final ComponentMap up

down

public final ComponentMap down

north

public final ComponentMap north

south

public final ComponentMap south

west

public final ComponentMap west

east

public final ComponentMap east

Constructor Detail

SidedComponentMap

public SidedComponentMap(ComponentProvider<?> provider)

Method Detail

getComponentsForDirections

public final java.util.Map<Direction,ComponentMap> getComponentsForDirections()

getComponents

public final ComponentMap getComponents(Direction direction)

add

public final <C extends Component> C add(java.lang.Class<C> componentType,
                                         Direction direction)

Adds a new component based on its superclass or interface using dependency injection.

Type Parameters:

C - The node type.

Parameters:

direction - The direction to add the component to.

componentType - The interface or abstract class associated with the new component.

Returns:

A new node of N type.

add

public final <C extends Component> C add(java.lang.Class<C> componentType,
                                         Direction... directions)

Adds a new component based on its superclass or interface using dependency injection.

Type Parameters:

C - The node type.

Parameters:

directions - The directions to add the component to.

componentType - The interface or abstract class associated with the new component.

Returns:

A new node of N type.

add

public final <C extends Component> C add(C component,
                                         Direction direction)

Adds a component to the provider.

Type Parameters:

C - The component type.

Parameters:

direction - The direction to add the component to.

component - The component to add.

Returns:

the component.

Throws:

ComponentException - when the component already exists on the block.

add

public final <C extends Component> C add(C component,
                                         Direction... directions)

Adds a component to the provider.

Type Parameters:

C - The component type.

Parameters:

component - The component to add.

directions - The directions to add the component to.

Returns:

the component.

Throws:

ComponentException - when the component already exists on the block.

getOrAdd

public final <C extends Component> C getOrAdd(C component,
                                              Direction direction)

Adds a component to the block if it is not present.

Type Parameters:

C - The component type.

Parameters:

component - The component to add.

direction - The direction to get or add the component to.

Returns:

the component.

has

public final boolean has(java.lang.Class<?> componentType,
                         Direction direction)

Checks if a component type exists in this provider.

Parameters:

componentType - the component type to check.

direction - The direction to check.

Returns:

true if the component exists on the provider.

canRemove

public final boolean canRemove(java.lang.Class<?> componentType,
                               Direction direction)

Checks if a component type can be removed from this provider.

Parameters:

componentType - the component type to check.

direction - The direction to check.

Returns:

true if the component exists on the provider.

remove

public final <C extends Component> C remove(C component,
                                            Direction direction)

Removes the component from the block.

Type Parameters:

C - The component type.

Parameters:

component - the component type.

direction - The direction to remove the component from.

Returns:

the component removed.

Throws:

ComponentException - when the component does not exist.

remove

public final <C extends Component> C remove(java.lang.Class<C> componentType,
                                            Direction direction)

Removes the component from the provider.

Type Parameters:

C - The component type.

Parameters:

componentType - the component type.

direction - The direction to remove the component from.

Returns:

the component removed.

Throws:

ComponentException - when the component does not exist.

getOp

public final <C> java.util.Optional<C> getOp(java.lang.Class<C> componentType,
                                             Direction direction)

Gets an optional of the component with the specified type.

Type Parameters:

C - The component type.

Parameters:

componentType - the type to get.

direction - The direction to get the component from.

Returns:

the optional of the component found or Optional.empty(). if the component was not found.

get

public final <C> C get(java.lang.Class<C> componentType,
                       Direction direction)

Gets the component with the specified type.

Type Parameters:

C - The component type.

Parameters:

componentType - the type to get.

direction - The direction to get the component from.

Returns:

the component.

Throws:

ComponentException - if the component doesn't exist.

getSet

public final <C> java.util.Set<C> getSet(java.lang.Class<C> componentType,
                                         Direction direction)

Gets the set of the components with the specified type.

Type Parameters:

C - The component type.

Parameters:

componentType - the type to get.

direction - The direction to get the component from.

Returns:

the set of the components.