PropertySource (Solace JMS API v10.6.2)

java.lang.Object
- com.solacesystems.common.property.PropertySource<T>

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

MapPropertySource, SystemPropertySource
```
public class PropertySource<T>
extends Object
implements Cloneable
```

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_NULL_VALID`
`static int`	`DEFAULT_PRIORITY`
`static int`	`HIGHEST_PRIORITY`
`static int`	`LOWEST_PRIORITY`
`static boolean`	`NULL_INVALID`
`static boolean`	`NULL_VALID` Convenience nullValid fields.
`static int`	`PRIORITY_1` Convenience priority fields.
`static int`	`PRIORITY_2`
`static int`	`PRIORITY_3`
`static int`	`PRIORITY_4`
`static int`	`PRIORITY_5`
`static int`	`PRIORITY_6`
`static int`	`PRIORITY_7`

Constructor Summary

Constructors
Constructor and Description
`PropertySource(PropertySource<T> source)` Deep Copy Constructor
`PropertySource(String name)`
`PropertySource(String name, boolean nullValid)`
`PropertySource(String name, int priority)`
`PropertySource(String name, int priority, boolean nullValid)`
`PropertySource(String name, int priority, boolean nullValid, PropertyConverter converter)`
`PropertySource(String name, int priority, PropertyConverter converter)`
`PropertySource(String name, PropertyConverter converter)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(PropertySourceChangeListener<T> listener)`
`void`	`addVetoableListener(VetoablePropertySourceChangeListener<T> listener)`
`Object`	`clone()`
`PropertyConverter`	`getConverter()`
`String`	`getName()`
`boolean`	`getPrintable()`
`int`	`getPriority()`
`boolean`	`getTrimStrings()`
`HashMap<String,Object>`	`getUserDataMap()`
`T`	`getValue()`
`void`	`initialize()` Used for initializing the value of sources.
`boolean`	`isNullValid()`
`boolean`	`isSet()`
`void`	`removeListener(PropertySourceChangeListener<T> listener)`
`void`	`removeVetoableListener(VetoablePropertySourceChangeListener<T> listener)`
`void`	`setObjectValue(Object value)`
`void`	`setPrintable(boolean printable)`
`void`	`setPriority(int priority)`
`void`	`setTrimStrings(boolean trimStrings)`
`void`	`setUserDataMap(HashMap<String,Object> map)`
`void`	`setValue(T value)`
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- PRIORITY_1
```
public static final int PRIORITY_1
```
  Convenience priority fields. Looks better than just having "1" on the command line.
  
  See Also:
  
  Constant Field Values
- PRIORITY_2
```
public static final int PRIORITY_2
```
  See Also:
  
  Constant Field Values
- PRIORITY_3
```
public static final int PRIORITY_3
```
  See Also:
  
  Constant Field Values
- PRIORITY_4
```
public static final int PRIORITY_4
```
  See Also:
  
  Constant Field Values
- PRIORITY_5
```
public static final int PRIORITY_5
```
  See Also:
  
  Constant Field Values
- PRIORITY_6
```
public static final int PRIORITY_6
```
  See Also:
  
  Constant Field Values
- PRIORITY_7
```
public static final int PRIORITY_7
```
  See Also:
  
  Constant Field Values
- HIGHEST_PRIORITY
```
public static final int HIGHEST_PRIORITY
```
  See Also:
  
  Constant Field Values
- LOWEST_PRIORITY
```
public static final int LOWEST_PRIORITY
```
  See Also:
  
  Constant Field Values
- DEFAULT_PRIORITY
```
public static final int DEFAULT_PRIORITY
```
  See Also:
  
  Constant Field Values
- NULL_VALID
```
public static final boolean NULL_VALID
```
  Convenience nullValid fields. Looks better than just having "true" or "false" on the command line.
  
  See Also:
  
  Constant Field Values
- NULL_INVALID
```
public static final boolean NULL_INVALID
```
  See Also:
  
  Constant Field Values
- DEFAULT_NULL_VALID
```
public static boolean DEFAULT_NULL_VALID
```

Constructor Detail

PropertySource
```
public PropertySource(PropertySource<T> source)
```
Deep Copy Constructor

Parameters:

source - PropertySource to be copied.

PropertySource
```
public PropertySource(String name)
```

PropertySource

public PropertySource(String name,
                      int priority)

PropertySource

public PropertySource(String name,
                      boolean nullValid)

PropertySource

public PropertySource(String name,
                      PropertyConverter converter)

PropertySource

public PropertySource(String name,
                      int priority,
                      boolean nullValid)

PropertySource

public PropertySource(String name,
                      int priority,
                      PropertyConverter converter)

PropertySource

public PropertySource(String name,
                      int priority,
                      boolean nullValid,
                      PropertyConverter converter)

Method Detail

getName
```
public String getName()
```

getPriority
```
public int getPriority()
```

getValue
```
public T getValue()
```

isSet
```
public boolean isSet()
```

isNullValid
```
public boolean isNullValid()
```

setTrimStrings

public void setTrimStrings(boolean trimStrings)

getTrimStrings
```
public boolean getTrimStrings()
```

setPrintable

public void setPrintable(boolean printable)

getPrintable
```
public boolean getPrintable()
```

getConverter

public PropertyConverter getConverter()

addListener

public void addListener(PropertySourceChangeListener<T> listener)

removeListener

public void removeListener(PropertySourceChangeListener<T> listener)

addVetoableListener

public void addVetoableListener(VetoablePropertySourceChangeListener<T> listener)

removeVetoableListener

public void removeVetoableListener(VetoablePropertySourceChangeListener<T> listener)

getUserDataMap

public HashMap<String,Object> getUserDataMap()

setUserDataMap

public void setUserDataMap(HashMap<String,Object> map)

initialize
```
public void initialize()
                throws PropertyVetoException,
                       PropertyConversionException
```
Used for initializing the value of sources. This should be called by the Property.initialize() method only. Sources generally shouldn't be set before adding them to a property. Initialize() gives a way of setting the value of the property source when the logic for calculating the property is within the source itself. This will ensure the set value will be checked by property vetoers. If the source value is set in the constructor (of a subclass) the value will not be checked by vetoers.

Throws:

PropertyVetoException - on error

PropertyConversionException - on error

setValue

public void setValue(T value)
              throws PropertyVetoException

Throws:: PropertyVetoException

setPriority

public void setPriority(int priority)
                 throws PropertyVetoException

Throws:: PropertyVetoException

setObjectValue

public void setObjectValue(Object value)
                    throws PropertyConversionException,
                           PropertyVetoException

Throws:: PropertyConversionException; PropertyVetoException

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:: clone in class Object
Throws:: CloneNotSupportedException

toString
```
public String toString()
```
Overrides:

toString in class Object

Class PropertySource<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRIORITY_1

PRIORITY_2

PRIORITY_3

PRIORITY_4

PRIORITY_5

PRIORITY_6

PRIORITY_7

HIGHEST_PRIORITY

LOWEST_PRIORITY

DEFAULT_PRIORITY

NULL_VALID

NULL_INVALID

DEFAULT_NULL_VALID

Constructor Detail

PropertySource

PropertySource

PropertySource

PropertySource

PropertySource

PropertySource

PropertySource

PropertySource

Method Detail

getName

getPriority

getValue

isSet

isNullValid

setTrimStrings

getTrimStrings

setPrintable

getPrintable

getConverter

addListener

removeListener

addVetoableListener

removeVetoableListener

getUserDataMap

setUserDataMap

initialize

setValue

setPriority

setObjectValue

clone

toString