SiteMinder
Java SDK r12.51


com.netegrity.sdk.apiutil
Class SmProperty

java.lang.Object
  extended by com.netegrity.sdk.apiutil.SmProperty
All Implemented Interfaces:
java.io.Serializable

public class SmProperty
extends java.lang.Object
implements java.io.Serializable

Holds the name, value, and type (encrypted or unencrypted) of a property.

Since:
SDK 6.0
See Also:
Serialized Form

Field Summary
static java.lang.Character UNIT_SEPARATOR
          This Constant is Unit Separator which is used to separate the property name, value and type in the string representation of Smproperty object.
 
Constructor Summary
SmProperty()
          Constructs an empty Property object.
SmProperty(SmProperty property)
          Copy Constructor.
SmProperty(java.lang.String name, java.lang.String value)
          Constructs a Property object with the specified name and value
SmProperty(java.lang.String name, java.lang.String value, int type)
          Constructs a Property object with the specified name, value and type.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getName()
          Gets the name of the property.
 int getType()
          Gets the type of the property.
 java.lang.String getValue()
          Gets the value of the property.
 int hashCode()
           
 void setName(java.lang.String name)
          Sets the name of the property.
 void setType(int type)
          Sets the type of the property.
 void setValue(java.lang.String value)
          Sets the value of the property.
 java.lang.String toString()
          Returns String representation of SmProperty Object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

UNIT_SEPARATOR

public static final java.lang.Character UNIT_SEPARATOR
This Constant is Unit Separator which is used to separate the property name, value and type in the string representation of Smproperty object.

Constructor Detail

SmProperty

public SmProperty()

Constructs an empty Property object.

This constructor sets the property name and value to empty strings and the property type to zero.


SmProperty

public SmProperty(java.lang.String name,
                  java.lang.String value)

Constructs a Property object with the specified name and value

The property type is set to the default (that is, unencrypted/plain text).

Parameters:
name - Name of the property.
value - Value of the property.

SmProperty

public SmProperty(java.lang.String name,
                  java.lang.String value,
                  int type)
Constructs a Property object with the specified name, value and type.

Parameters:
name - Name of the property.
value - Value of the property.
type - Type of the property, where:
    1 Indicates that the property is encrypted.
    2 Indicates the property is unencrypted (plain text).

SmProperty

public SmProperty(SmProperty property)
Copy Constructor. Constructs a Property object with using the specified Property object.

Parameters:
property - The property object to be copied
Method Detail

setName

public void setName(java.lang.String name)
Sets the name of the property.

Parameters:
name - The name of the object.

getName

public java.lang.String getName()
Gets the name of the property.

Returns:
The name of the property.

setValue

public void setValue(java.lang.String value)
Sets the value of the property.

Parameters:
value - The value of the object.

getValue

public java.lang.String getValue()
Gets the value of the property.

Returns:
The value of the property.

setType

public void setType(int type)
Sets the type of the property.

Parameters:
type - The name of the type.

getType

public int getType()
Gets the type of the property.

Returns:
The type of the property.

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Returns String representation of SmProperty Object.

Overrides:
toString in class java.lang.Object
Returns:
String.

SiteMinder
Java SDK r12.51

Mon 04/08/2013

http://ca.com
Copyright (c) 2013 CA.