SmartSockets .NET Class Library

TipcOption Members

Public Instance Properties

LegalValueList Returns an ArrayList of legal value Strings, which may be empty.
Protected Options can be marked as "protected", so they cannot be monitored.
ReadOnly Options can be marked as "read only", so they cannot be set.
Value Sets the value of an option. No error checking is done on the value.
ValueBool Gets the value of the option as a boolean. The rules for the value of the option are the same as JDK library method Boolean.booleanValue.
ValueDouble Gets the value of the option as a double.
ValueEnum Gets the value of the option and verifies it against a list of legal values. For example, if you have a list of names: "foo", "bar", "baz"; and the value is "baz", then "baz" would be returned. If the value was "whiffle", then an exception would be thrown, since this value does not appear in the list of legal values. The list of legal values is set with addEnumLegalValue.
ValueEnumMap Gets the value of the option and maps it to an enumerated list. For example, if you have a list of names: "first", "second" and "third"; and you want to use those internally as 1, 2, 3; then you would use this to get the value. You must first set the map ("first" = 1, "second" = 2, etc.) with addEnumMapValidValue.
ValueInt Gets the value of the option as an int.
ValueList Parses the value containing a comma-separated list into a Vector of Strings.
ValueStr Gets the value of the option as a String.

Public Instance Methods

addEnumLegalValue Adds an enum name to the list of valid names.
addEnumMapLegalValue Adds an enum map name and value to the list of valid names.
clearEnumLegalValues Clears the list of enumerated legal values.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
getName Gets the name of the option. This is the same as the name that is used to get the option.
GetType (inherited from Object)Gets the Type of the current instance.
isRequired Some options are required for SmartSockets to operate properly. This property is set internally by the library and may not be modified.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

TipcOption Class | TIBCO.SMARTSOCKETS Namespace


Copyright © TIBCO Software Inc. All rights reserved