net.sf.basedb.util.extensions.xml
Enum PathType

java.lang.Object
  java.lang.Enum<PathType>
      net.sf.basedb.util.extensions.xml.PathType

All Implemented Interfaces:

Serializable, Comparable<PathType>

public enum PathType
extends Enum<PathType>

Specify the type of paths. It is used by the PathSetter annotation and PathConverter.

Since:

2.17

Author:

Nicklas

Last modified

$Date: 2010-11-10 12:16:51 +0100 (Wed, 10 Nov 2010) $

Enum Constant Summary

ABSOLUTE
Paths should be absolute paths from the root of the web server.

CONTEXT_RELATIVE
Paths should be relative to the web application context.

Method Summary

static PathType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PathType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ABSOLUTE

public static final PathType ABSOLUTE

Paths should be absolute paths from the root of the web server.

CONTEXT_RELATIVE

public static final PathType CONTEXT_RELATIVE

Paths should be relative to the web application context. The difference is usually that the first part of the absolute path is missing.

Method Detail

values

public static PathType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PathType c : PathType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PathType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null