com.sapportals.wcm.util.config

Class ConfigPropertyDef

java.lang.Object
  com.sapportals.wcm.util.config.ConfigPropertyDef

public class ConfigPropertyDef

extends Object

ConfigPropertyDef is a definition of a configuration property. Copyright (c) SAP AG 2001-2002

Field Summary

static int	BOOLEAN
static int	EXISTINGFILE
static int	EXISTINGPATH
static int	INTEGER
static int	JAVACLASS
static int	STRING
static int	URI
static int	URL

Constructor Summary

ConfigPropertyDef(String name, String displayName, int type, boolean required, String defaultValue)
Create a ConfigPropertyDef.

Method Summary

String	check(ConfigCollection collection) Check if a property matches its definition.
String	getDefaultValue() Get the default value of the property.
String	getDisplayName() Get the display name of the configuration property.
String	getName() Get the name of the configuration property.
int	getType() Get the type of the configuration property.
boolean	isRequired() Chreck if the configuration property is required.

Methods inherited from class java.lang.Object

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

Field Detail

STRING

public static final int STRING

See Also:

Constant Field Values

INTEGER

public static final int INTEGER

See Also:

Constant Field Values

EXISTINGPATH

public static final int EXISTINGPATH

See Also:

Constant Field Values

EXISTINGFILE

public static final int EXISTINGFILE

See Also:

Constant Field Values

JAVACLASS

public static final int JAVACLASS

See Also:

Constant Field Values

URL

public static final int URL

See Also:

Constant Field Values

URI

public static final int URI

See Also:

Constant Field Values

BOOLEAN

public static final int BOOLEAN

See Also:

Constant Field Values

Constructor Detail

ConfigPropertyDef

public ConfigPropertyDef(String name,
                         String displayName,
                         int type,
                         boolean required,
                         String defaultValue)

Create a ConfigPropertyDef.

Parameters:

name - The name (relativ path) of the property

displayName - The display name of the property

type - The type of the property. Valid Types are:

• STRING: A string
• INTEGER: An integer
• EXISTINGPATH: A path on the (local) filesystem
• EXISTINGFILE: A file on the (local) filesystem
• JAVACLASS: A java class in the (local) classpath
• URL: A fully qualified URL
• URI: An URI
• BOOLEAN: A boolean value (true/false)
required - true if the property is required
defaultValue - The default value of the property (null if none)

Method Detail

getName

public String getName()

Get the name of the configuration property.

Returns:

The name of the configuration property

getDisplayName

public String getDisplayName()

Get the display name of the configuration property.

Returns:

The display name of the configuration property

getType

public int getType()

Get the type of the configuration property.

Returns:

The type of the configuration property

isRequired

public boolean isRequired()

Chreck if the configuration property is required.

Returns:

true if the configuration property is required

getDefaultValue

public String getDefaultValue()

Get the default value of the property.

Returns:

The default value of the property

check

public String check(ConfigCollection collection)

Check if a property matches its definition.

Parameters:

collection - The configuration collection to be checked

Returns:

a problem report or null if the check passed