Package com.perforce.p4java.admin

Class ServerConfigurationValue

java.lang.Object

com.perforce.p4java.admin.ServerConfigurationValue

public class ServerConfigurationValue
extends java.lang.Object

Encapsulates the server configuration values that are available through the IOptionsServer set/get server configuration methods.

This class is complicated by the fact that any or all of the fields may be set or null, and by the way that the same config name may have several different ServerConfigurationValue objects depending on how the variable has been set. As this class is intended for advanced admin use only, none of the fields are documented in any detail here -- see the main Perforce documentation for the 'configure' operation for a full explanation.

Since:

2011.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServerConfigurationValue.ConfigType	Currently-known server configuration value types.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALL_SERVERS	Special string value used to signal that the corresponding config value is available to (or defined for) all participating servers.

Constructor Summary

Constructors

Constructor	Description
ServerConfigurationValue()	Default constructor -- all fields set to null except type, which is set to ConfigType.UNKNOWN.
ServerConfigurationValue(java.lang.String serverName, ServerConfigurationValue.ConfigType type, java.lang.String name, java.lang.String value)	Explicit value constructor.
ServerConfigurationValue(java.lang.String serverName, java.lang.String type, java.lang.String name, java.lang.String value)	Explicit value convenience constructor with string 'type' field, which is converted to ConfigType on the fly.
ServerConfigurationValue(java.util.Map<java.lang.String,java.lang.Object> map)	Constructor for map-based returns from the server; not intended for general use.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	Gets the name.
java.lang.String	getServerName()	Gets the server name.
ServerConfigurationValue.ConfigType	getType()	Gets the type.
java.lang.String	getValue()	Gets the value.
ServerConfigurationValue	setName(java.lang.String name)	Sets the name.
ServerConfigurationValue	setServerName(java.lang.String serverName)	Sets the server name.
ServerConfigurationValue	setType(ServerConfigurationValue.ConfigType type)	Sets the type.
ServerConfigurationValue	setValue(java.lang.String value)	Sets the value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ALL_SERVERS

public static final java.lang.String ALL_SERVERS

Special string value used to signal that the corresponding config value is available to (or defined for) all participating servers.

See Also:

Constant Field Values

Constructor Detail

ServerConfigurationValue

public ServerConfigurationValue()

Default constructor -- all fields set to null except type, which is set to ConfigType.UNKNOWN.

ServerConfigurationValue

public ServerConfigurationValue(java.lang.String serverName,
                                ServerConfigurationValue.ConfigType type,
                                java.lang.String name,
                                java.lang.String value)

Explicit value constructor.

Parameters:

serverName - the server name

type - the type

name - the name

value - the value

ServerConfigurationValue

public ServerConfigurationValue(java.lang.String serverName,
                                java.lang.String type,
                                java.lang.String name,
                                java.lang.String value)

Explicit value convenience constructor with string 'type' field, which is converted to ConfigType on the fly.

Parameters:

serverName - the server name

type - the type

name - the name

value - the value

ServerConfigurationValue

public ServerConfigurationValue(java.util.Map<java.lang.String,java.lang.Object> map)

Constructor for map-based returns from the server; not intended for general use.

Parameters:

map - the map

Method Detail

getServerName

public java.lang.String getServerName()

Gets the server name.

Returns:

the server name

setServerName

public ServerConfigurationValue setServerName(java.lang.String serverName)

Sets the server name.

Parameters:

serverName - the server name

Returns:

the server configuration value

getType

public ServerConfigurationValue.ConfigType getType()

Gets the type.

Returns:

the type

setType

public ServerConfigurationValue setType(ServerConfigurationValue.ConfigType type)

Sets the type.

Parameters:

type - the type

Returns:

the server configuration value

getName

public java.lang.String getName()

Gets the name.

Returns:

the name

setName

public ServerConfigurationValue setName(java.lang.String name)

Sets the name.

Parameters:

name - the name

Returns:

the server configuration value

getValue

public java.lang.String getValue()

Gets the value.

Returns:

the value

setValue

public ServerConfigurationValue setValue(java.lang.String value)

Sets the value.

Parameters:

value - the value

Returns:

the server configuration value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object