com.lightysoft.logmx.business

Enum LogURLParameterType

java.lang.Object

java.lang.Enum<LogURLParameterType>

com.lightysoft.logmx.business.LogURLParameterType

All Implemented Interfaces:

Serializable, Comparable<LogURLParameterType>

public enum LogURLParameterType
extends Enum<LogURLParameterType>

A LogURLParameterType defines the type of data contained in a LogURLParameter.

Parameter types are used by LogMX to render the "Open log file" dialog and to check LogURL parameters validity.

Since:

LogMX v1.2.2

Author:

LightySoft

See Also:

LogURLParameter

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOLEAN Denotes any Boolean parameter
ENUM Denotes an enumeration of possible values
FILEPATH Denotes a file path, which can be any value of String
HOST Denotes a host name, which can be any value of String Since LogMX v4.0.1, if an IPv6 address is detected (character ":" used in host), this host is protected with surrounding "[" and "]" for String conversion, to avoid conflict with patterns like "host:port" (RFC 5952)
INTEGER Denotes any Integer parameter, which can be any value of Integer
LOCAL_DIRECTORY Denotes a local directory path
LOGIN Denotes a user login, which can be any value of String
PASSWORD Denotes a user password, which can be any value of String.
STRING Denotes any String parameter

Method Summary

Modifier and Type	Method and Description
String	toString() Returns the name of this Type
static LogURLParameterType	valueOf(String name) Returns the enum constant of this type with the specified name.
static LogURLParameterType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STRING

public static final LogURLParameterType STRING

Denotes any String parameter

Since:

LogMX v1.2.2

INTEGER

public static final LogURLParameterType INTEGER

Denotes any Integer parameter, which can be any value of Integer

Since:

LogMX v1.2.2

BOOLEAN

public static final LogURLParameterType BOOLEAN

Denotes any Boolean parameter

Since:

LogMX v1.2.2

HOST

public static final LogURLParameterType HOST

Denotes a host name, which can be any value of String
Since LogMX v4.0.1, if an IPv6 address is detected (character ":" used in host), this host is protected with surrounding "[" and "]" for String conversion, to avoid conflict with patterns like "host:port" (RFC 5952)

Since:

LogMX v1.2.2

LOGIN

public static final LogURLParameterType LOGIN

Denotes a user login, which can be any value of String

Since:

LogMX v1.2.2

PASSWORD

public static final LogURLParameterType PASSWORD

Denotes a user password, which can be any value of String. Use this parameter type if you don't want to use LogMX password repository. The user will then have to re-type their password each time the Manager wants to access a resource.

To use LogMX password repository, see LogFileManager.getOrAskUserPassword(String, String)

Since:

LogMX v1.2.2

FILEPATH

public static final LogURLParameterType FILEPATH

Denotes a file path, which can be any value of String

Since:

LogMX v1.2.2

LOCAL_DIRECTORY

public static final LogURLParameterType LOCAL_DIRECTORY

Denotes a local directory path

Since:

LogMX v3.2.0

ENUM

public static final LogURLParameterType ENUM

Denotes an enumeration of possible values

Since:

LogMX v4.0.0

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Returns the name of this Type

Overrides:

toString in class Enum<LogURLParameterType>

See Also:

Enum.toString()