nova.core.component

Class ComponentMap

java.lang.Object

java.util.AbstractMap<K,V>

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

nova.core.component.ComponentMap

All Implemented Interfaces:

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

Direct Known Subclasses:

SidedComponentMap

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

A class that contains all components.

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
ComponentProvider<?>	provider

Constructor Summary

Constructors

Constructor and Description
ComponentMap(ComponentProvider<?> provider)

Method Summary

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

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

provider

public final ComponentProvider<?> provider

Constructor Detail

ComponentMap

public ComponentMap(ComponentProvider<?> provider)

Method Detail

add

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

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

Type Parameters:

C - The component type.

Parameters:

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

Returns:

The added component.

add

public final <C extends Component> C add(C component)

Adds a component to the provider.

Type Parameters:

C - The component type.

Parameters:

component - The component to add.

Returns:

The added component.

Throws:

ComponentException - when the component already exists on the block.

getOrAdd

public final <C extends Component> C getOrAdd(C component)

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

Type Parameters:

C - The component type.

Parameters:

component - The component to add.

Returns:

The component present on this interface

has

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

Checks if a component type exists in this provider.

Parameters:

componentType - the component type to check.

Returns:

true if the component exists on the provider.

remove

public final <C extends Component> C remove(C component)

Removes a component from the block.

Type Parameters:

C - The component type.

Parameters:

component - The component to remove.

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)

Removes the component from the provider.

Type Parameters:

C - The component type.

Parameters:

componentType - the component type.

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)

Gets an optional of the component with the specified type.

Type Parameters:

C - The component type.

Parameters:

componentType - the type to get.

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)

Gets the component with the specified type.

Type Parameters:

C - The component type.

Parameters:

componentType - the type to get.

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)

Gets the set of the components with the specified type.

Type Parameters:

C - The component type.

Parameters:

componentType - the type to get.

Returns:

the set of the components.