org.clapper.curn.output.freemarker
Class TemplateLocation

java.lang.Object
  org.clapper.curn.output.freemarker.TemplateLocation

All Implemented Interfaces:

java.lang.Comparable<TemplateLocation>

public class TemplateLocation
extends java.lang.Object
implements java.lang.Comparable<TemplateLocation>

Version:

$Revision: 6301 $

Method Summary

int	compareTo(TemplateLocation o) Compare this object and another object for order.
boolean	equals(java.lang.Object o) Compare this object and another object for equality.
java.lang.String	getLocation() Get the location string for this template location.
java.lang.String	getName() Get a FreeMarker-suitable name for this template.
TemplateType	getType() Get the type of this template location.
java.lang.String	toString() Get a string representation of this object.

Methods inherited from class java.lang.Object

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

Method Detail

compareTo

public int compareTo(TemplateLocation o)

Compare this object and another object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface java.lang.Comparable<TemplateLocation>

Parameters:

o - the other object to be compared with this one

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than o.

equals

public boolean equals(java.lang.Object o)

Compare this object and another object for equality.

Overrides:

equals in class java.lang.Object

Parameters:

o - the other object to be compared with this one

Returns:

true if the other object is equivalent to this one, false otherwise.

toString

public java.lang.String toString()

Get a string representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

the string representation

getName

public java.lang.String getName()

Get a FreeMarker-suitable name for this template.

Returns:

the name

getType

public TemplateType getType()

Get the type of this template location.

Returns:

the type

See Also:

TemplateType

getLocation

public java.lang.String getLocation()

Get the location string for this template location. How the returned string is interpreted depends on the type.

Returns:

the location string

See Also:

getType()