Package de.ellpeck.rockbottom.api.util.reg

Interface IResourceName

All Superinterfaces:

java.lang.Comparable<IResourceName>

public interface IResourceName
extends java.lang.Comparable<IResourceName>

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. New resource names can be created using RockBottomAPI.createRes(IMod, String) or RockBottomAPI.createRes(String). Creating a custom implementation of this class is discouraged.

Method Summary

Modifier and Type	Method	Description
IResourceName	addPrefix(java.lang.String prefix)	Returns a new resource name with the given prefix added to the front of the resource.
IResourceName	addSuffix(java.lang.String suffix)	Returns a new resource name with the given suffix added to the end of the resource.
java.lang.String	getDomain()	Returns the domain of this resource name.
java.lang.String	getResourceName()	Returns the name of this resource

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getDomain

java.lang.String getDomain()

Returns the domain of this resource name.

Returns:

The domain

See Also:

getResourceName(), Constants.RESOURCE_SEPARATOR

getResourceName

java.lang.String getResourceName()

Returns the name of this resource

Returns:

The name

See Also:

getDomain(), Constants.RESOURCE_SEPARATOR

addPrefix

IResourceName 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

IResourceName 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