WebConfigParam (Liferay Faces Util 4.2.5-ga6 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

com.liferay.faces.util.config
Enum WebConfigParam

java.lang.Object
  java.lang.Enum<WebConfigParam>
      com.liferay.faces.util.config.WebConfigParam

All Implemented Interfaces:: ConfigParam<javax.faces.context.ExternalContext>, Serializable, Comparable<WebConfigParam>

public enum WebConfigParam
extends Enum<WebConfigParam>
implements ConfigParam<javax.faces.context.ExternalContext>
extends Enum<WebConfigParam>
implements ConfigParam<javax.faces.context.ExternalContext>

Author:: Neil Griffin

Enum Constant Summary
`ResolveXMLEntities` Boolean indicating whether or not XML entities should be resolved
`UploadedFileMaxSize` Maximum file size for an uploaded file.
`UploadedFilesDir` Absolute path to a directory (folder) in which the uploaded file data should be written to.

Method Summary
`String`	`getAlternateName()` Returns the alternate name of the config param (or null if there is not an alternate name).
`boolean`	`getBooleanValue(javax.faces.context.ExternalContext externalContext)` Returns the boolean value of the config param.
`String`	`getConfiguredValue(javax.faces.context.ExternalContext externalContext)` Returns the value of the config param that was specified in the configuration file.
`boolean`	`getDefaultBooleanValue()` Returns the default boolean value of the config param.
`int`	`getDefaultIntegerValue()` Returns the default int value of the config param.
`long`	`getDefaultLongValue()` Returns the default long value of the config param.
`String`	`getDefaultStringValue()` Returns the default String value of the config param.
`int`	`getIntegerValue(javax.faces.context.ExternalContext externalContext)` Returns the int value of the config param.
`long`	`getLongValue(javax.faces.context.ExternalContext externalContext)` Returns the long value of the config param.
`String`	`getName()` Returns the name of the config param.
`String`	`getStringValue(javax.faces.context.ExternalContext externalContext)` Returns the String value of the config param.
`boolean`	`isConfigured(javax.faces.context.ExternalContext externalContext)` Flag indicating whether or not the config param was specified in the configuration file.
`static WebConfigParam`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static WebConfigParam[]`	`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

ResolveXMLEntities

public static final WebConfigParam ResolveXMLEntities

Boolean indicating whether or not XML entities should be resolved

UploadedFilesDir

public static final WebConfigParam UploadedFilesDir

Absolute path to a directory (folder) in which the uploaded file data should be written to. Default value is the value of the system property "java.io.tmpdir".

UploadedFileMaxSize

public static final WebConfigParam UploadedFileMaxSize

Maximum file size for an uploaded file. Default is 104857600 bytes (100MB)

Method Detail

values

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

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

valueOf

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