com.sun.n1.sps.model.component
Interface ComponentRef

public interface ComponentRef

A reference to a component.

Method Summary

java.lang.String	getComponentFullName() Returns the full name of the component, which includes both the path and the name.
java.lang.String	getComponentName() Returns the name of the component this is referenced to.
FolderID	getPath() Returns the absolute path that the referenced component is located in.
java.lang.String	getPathString() Returns the path as a string.
boolean	hasUnresolvedPath() Returns true if the path of this reference is unresolved, false otherwise.

Method Detail

getComponentName

java.lang.String getComponentName()

Returns the name of the component this is referenced to.

Returns:

The name of the component.

getPath

FolderID getPath()

Returns the absolute path that the referenced component is located in.

Returns:

the resolved absolute path of the component

Throws:

java.lang.NullPointerException - if this component has an unresolved path

hasUnresolvedPath

boolean hasUnresolvedPath()

Returns true if the path of this reference is unresolved, false otherwise.

Returns:

true iff the path is unresolved.

getPathString

java.lang.String getPathString()

Returns the path as a string. If path is unresovled, it is returned directly (and may be null). Otherwise the path is converted to a string, stripped of its trailing '/' (if non root) and returned.

Returns:

The path as a string.

getComponentFullName

java.lang.String getComponentFullName()

Returns the full name of the component, which includes both the path and the name. Note that if the path is unresolved, then the resulting full name may be a relative name.

Returns:

The full name of the component.