de.ellpeck.rockbottom.api.util.reg

Class ResourceName

java.lang.Object

de.ellpeck.rockbottom.api.util.reg.ResourceName

All Implemented Interfaces:

java.lang.Comparable<ResourceName>

public final class ResourceName
extends java.lang.Object
implements java.lang.Comparable<ResourceName>

A resource name that defines the name of a resource and the domain that it is created from. A resource name is structured in the following way: The domain, followed by Constants.RESOURCE_SEPARATOR, followed by the actual resource name.

The game's internal resource names use the IGameInstance instance from RockBottomAPI.getGame() as the domain. Using this in mods is highly discouraged and, if anything, should only be used to access existing internal resources, not create new ones.

Constructor Summary

Constructors

Constructor and Description
ResourceName(IMod mod, java.lang.String resourceName) Creates a resource name with the given IMod as the domain.
ResourceName(java.lang.String combined) Creates a resource name from a combined string.

Method Summary

Modifier and Type	Method and Description
ResourceName	addPrefix(java.lang.String prefix) Returns a new resource name with the given prefix added to the front of the resource.
ResourceName	addSuffix(java.lang.String suffix) Returns a new resource name with the given suffix added to the end of the resource.
int	compareTo(ResourceName o)
boolean	equals(java.lang.Object o)
java.lang.String	getDomain() Returns the domain of this resource name.
java.lang.String	getResourceName() Returns the name of this resource
int	hashCode()
static ResourceName	intern(java.lang.String resourceName) Creates an internal resource name that uses the IGameInstance instance from RockBottomAPI.getGame() as the domain.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceName

public ResourceName(IMod mod,
                    java.lang.String resourceName)

Creates a resource name with the given IMod as the domain.

Parameters:

mod - The mod domain

resourceName - The resource name

ResourceName

public ResourceName(java.lang.String combined)

Creates a resource name from a combined string. If the string does not contain the Constants.RESOURCE_SEPARATOR, then it will throw an IllegalArgumentException.

Parameters:

combined - The combined resource string

See Also:

toString()

Method Detail

intern

@ApiInternal
public static ResourceName intern(java.lang.String resourceName)

Creates an internal resource name that uses the IGameInstance instance from RockBottomAPI.getGame() as the domain. Using this in mods is highly discouraged and, if anything, should only be used to access existing internal resources, not create new ones.

Parameters:

resourceName - The name of the resource

Returns:

A new internal resource name

getDomain

public java.lang.String getDomain()

Returns the domain of this resource name.

Returns:

The domain

See Also:

getResourceName(), Constants.RESOURCE_SEPARATOR

getResourceName

public java.lang.String getResourceName()

Returns the name of this resource

Returns:

The name

See Also:

getDomain(), Constants.RESOURCE_SEPARATOR

addPrefix

public ResourceName addPrefix(java.lang.String prefix)

Returns a new resource name with the given prefix added to the front of the resource. For example, the resource name rockbottom/stone with the prefix dirty_ added to it would result in a new resource name rockbottom/dirty_stone, meaning the domain of the resource name stays unaffected by this action.

Parameters:

prefix - The prefix to add

Returns:

A new name with the prefix added

addSuffix

public ResourceName addSuffix(java.lang.String suffix)

Returns a new resource name with the given suffix added to the end of the resource. For example, the resource name rockbottom/stone with the suffix _pickaxe added to it would result in a new resource name rockbottom/stone_pickaxe, meaning the domain of the resource name stays unaffected by this action.

Parameters:

suffix - The suffix to add

Returns:

A new name with the suffix added

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(ResourceName o)

Specified by:

compareTo in interface java.lang.Comparable<ResourceName>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object