org.osgl.http.util

Enum Path

java.lang.Object

java.lang.Enum<Path>

org.osgl.http.util.Path

All Implemented Interfaces:

Serializable, Comparable<Path>

public enum Path
extends Enum<Path>

Method Summary

Methods

Modifier and Type	Method and Description
static String	fullUrl(String path) Returns the full url form of a url path which starts with scheme.
static String	fullUrl(String path, boolean secure) Return the full url form of a url path which starts with scheme.
static String	fullUrl(String path, H.Request req) Returns the full url form of a url path which starts with scheme.
static boolean	isAbsoluteUrl(String path) Check if a path is absolute.
static boolean	isFullUrl(String path) Check if a path is full URL including scheme
static List<String>	tokenize(char[] buf)
static List<String>	tokenize(char[] buf, int start)
static List<String>	tokenize(char[] buf, int start, char separator, char terminator)
static Iterator<String>	tokenizer(char[] buf)
static Iterator<String>	tokenizer(char[] buf, int start)
static Iterator<String>	tokenizer(char[] buf, int start, char separator, char terminator)
static String	url(String path) Returns a normalized url for a path.
static String	url(String path, H.Request req) Returns normalized form of URL path.
static Path	valueOf(String name) Returns the enum constant of this type with the specified name.
static Path[]	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

Method Detail

values

public static Path[] 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 (Path c : Path.values())
    System.out.println(c);

Returns:

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

valueOf

public static Path 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

isFullUrl

public static boolean isFullUrl(String path)

Check if a path is full URL including scheme

Parameters:

path - the path to be checked

Returns:

true if the path is full url

isAbsoluteUrl

public static boolean isAbsoluteUrl(String path)

Check if a path is absolute. A path is considered to be absolute if it is full url or it starts with "//"

Parameters:

path - the path to be checked

Returns:

true if the path is absolute

url

public static String url(String path)

Returns a normalized url for a path. If the path is absolute then it is returned directly.

Otherwise the path is prepended with the context path

Parameters:

path - the url path to be normalized

Returns:

the normalized url

url

public static String url(String path,
         H.Request req)

Returns normalized form of URL path. If the path is absolute then it is returned directly

Otherwise the path is prepended with the context info

If the request is null then url(String) is called

Parameters:

path - the url path to be normalized

req - the request instance

Returns:

full path of the URL specified

fullUrl

public static String fullUrl(String path)

Returns the full url form of a url path which starts with scheme. The scheme, domain, port, context path info are get from HttpConfig

Parameters:

path - the url path

Returns:

the full url of the path

fullUrl

public static String fullUrl(String path,
             boolean secure)

Return the full url form of a url path which starts with scheme. The domain, port and context path info are get from HttpConfig

Parameters:

path - the path to be normalized

secure - is the full url needs to be secure or no

Returns:

the full url of the path

fullUrl

public static String fullUrl(String path,
             H.Request req)

Returns the full url form of a url path which starts with scheme. the domain, port and context path info are get from the H.Request specified. If the request is null then it will call back fullUrl(String, boolean) with secure be set to false.

Parameters:

path - the path to be normalized

req - the http request from which the domain, port and context path are fetched

Returns:

the full url of the path

tokenizer

public static Iterator<String> tokenizer(char[] buf)

tokenizer

public static Iterator<String> tokenizer(char[] buf,
                         int start)

tokenizer

public static Iterator<String> tokenizer(char[] buf,
                         int start,
                         char separator,
                         char terminator)

tokenize

public static List<String> tokenize(char[] buf)

tokenize

public static List<String> tokenize(char[] buf,
                    int start)

tokenize

public static List<String> tokenize(char[] buf,
                    int start,
                    char separator,
                    char terminator)