Package dan200.computercraft.api.peripheral

Class PeripheralType

java.lang.Object

dan200.computercraft.api.peripheral.PeripheralType

public final class PeripheralType
extends Object

The type of a GenericPeripheral.

When determining the final type of the resulting peripheral, the union of all types is taken, with the lexicographically smallest non-empty name being chosen.

Constructor Summary

Constructors

Constructor	Description
PeripheralType(@Nullable String type, Set<String> additionalTypes)

Method Summary

Modifier and Type	Method	Description
Set<String>	getAdditionalTypes()	Get any additional types or "traits" of this peripheral.
@Nullable String	getPrimaryType()	Get the name of this peripheral type.
static PeripheralType	ofAdditional(String... additionalTypes)	Create a new peripheral type with no primary type but additional traits.
static PeripheralType	ofAdditional(Collection<String> additionalTypes)	Create a new peripheral type with no primary type but additional traits.
static PeripheralType	ofType(String type)	Create a new non-empty peripheral type.
static PeripheralType	ofType(String type, String... additionalTypes)	Create a new non-empty peripheral type with additional traits.
static PeripheralType	ofType(String type, Collection<String> additionalTypes)	Create a new non-empty peripheral type with additional traits.
static PeripheralType	untyped()	An empty peripheral type, used when a GenericPeripheral does not have an explicit type.

Methods inherited from class java.lang.Object

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

Constructor Details

PeripheralType

public PeripheralType(@Nullable String type,
 Set<String> additionalTypes)

Method Details

untyped

public static PeripheralType untyped()

An empty peripheral type, used when a GenericPeripheral does not have an explicit type.

Returns:

The empty peripheral type.

ofType

public static PeripheralType ofType(String type)

Create a new non-empty peripheral type.

Parameters:

type - The name of the type.

Returns:

The constructed peripheral type.

ofType

public static PeripheralType ofType(String type,
 Collection<String> additionalTypes)

Create a new non-empty peripheral type with additional traits.

Parameters:

type - The name of the type.

additionalTypes - Additional types, or "traits" of this peripheral. For instance, "inventory".

Returns:

The constructed peripheral type.

ofType

public static PeripheralType ofType(String type,
 String... additionalTypes)

Create a new non-empty peripheral type with additional traits.

Parameters:

type - The name of the type.

additionalTypes - Additional types, or "traits" of this peripheral. For instance, "inventory".

Returns:

The constructed peripheral type.

ofAdditional

public static PeripheralType ofAdditional(Collection<String> additionalTypes)

Create a new peripheral type with no primary type but additional traits.

Parameters:

additionalTypes - Additional types, or "traits" of this peripheral. For instance, "inventory".

Returns:

The constructed peripheral type.

ofAdditional

public static PeripheralType ofAdditional(String... additionalTypes)

Create a new peripheral type with no primary type but additional traits.

Parameters:

additionalTypes - Additional types, or "traits" of this peripheral. For instance, "inventory".

Returns:

The constructed peripheral type.

getPrimaryType

public @Nullable String getPrimaryType()

Get the name of this peripheral type. This may be null.

Returns:

The type of this peripheral.

See Also:

• IPeripheral.getType()

getAdditionalTypes

public Set<String> getAdditionalTypes()

Get any additional types or "traits" of this peripheral. These effectively act as a standard set of interfaces a peripheral might have.

Returns:

All additional types.

See Also:

• IPeripheral.getAdditionalTypes()