au.com.codeka.carrot.resource

Class ResourceName

java.lang.Object

au.com.codeka.carrot.resource.ResourceName

public abstract class ResourceName
extends java.lang.Object

The "name" of a resolved resource (usually a file, but not nessecarily). You can pass this to a resource locator to get the actual contents of the resource.

ResourceNames may be related to a parent ResourceName. They may not necessarily be direct children of the parent, in which case children will always be separated by a forward slash '/'.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name
protected ResourceName	parent

Constructor Summary

Constructors

Constructor and Description
ResourceName(ResourceName parent, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
abstract ResourceName	getParent()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final java.lang.String name

parent

@Nullable
protected final ResourceName parent

Constructor Detail

ResourceName

public ResourceName(@Nullable
                    ResourceName parent,
                    java.lang.String name)

Method Detail

getName

public java.lang.String getName()

Returns:

The name of this resource, which may be relative to the parent (i.e. not necessarily a direct child of the parent). Relative names are always separated with forward slash '/'.

getParent

@Nullable
public abstract ResourceName getParent()

Returns:

The parent ResourceName (may be null if this ResourceName is relative to the root).