com.perforce.p4java.admin
Class ServerConfigurationValue

java.lang.Object
  extended by com.perforce.p4java.admin.ServerConfigurationValue

public class ServerConfigurationValue
extends 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
static class ServerConfigurationValue.ConfigType
          Currently-known server configuration value types.
 
Field Summary
static 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
ServerConfigurationValue()
          Default constructor -- all fields set to null except type, which is set to ConfigType.UNKNOWN.
ServerConfigurationValue(Map<String,Object> map)
          Constructor for map-based returns from the server; not intended for general use.
ServerConfigurationValue(String serverName, ServerConfigurationValue.ConfigType type, String name, String value)
          Explicit value constructor.
ServerConfigurationValue(String serverName, String type, String name, String value)
          Explicit value convenience constructor with string 'type' field, which is converted to ConfigType on the fly.
 
Method Summary
 String getName()
           
 String getServerName()
           
 ServerConfigurationValue.ConfigType getType()
           
 String getValue()
           
 ServerConfigurationValue setName(String name)
           
 ServerConfigurationValue setServerName(String serverName)
           
 ServerConfigurationValue setType(ServerConfigurationValue.ConfigType type)
           
 ServerConfigurationValue setValue(String value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALL_SERVERS

public static final 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(String serverName,
                                ServerConfigurationValue.ConfigType type,
                                String name,
                                String value)
Explicit value constructor.


ServerConfigurationValue

public ServerConfigurationValue(String serverName,
                                String type,
                                String name,
                                String value)
Explicit value convenience constructor with string 'type' field, which is converted to ConfigType on the fly.


ServerConfigurationValue

public ServerConfigurationValue(Map<String,Object> map)
Constructor for map-based returns from the server; not intended for general use.

Method Detail

getServerName

public String getServerName()

setServerName

public ServerConfigurationValue setServerName(String serverName)

getType

public ServerConfigurationValue.ConfigType getType()

setType

public ServerConfigurationValue setType(ServerConfigurationValue.ConfigType type)

getName

public String getName()

setName

public ServerConfigurationValue setName(String name)

getValue

public String getValue()

setValue

public ServerConfigurationValue setValue(String value)


Copyright © 2015 Perforce Software. All Rights Reserved.