xmlBlaster 2.2.0 client API

org.xmlBlaster.util.property
Class PropEntry

java.lang.Object
  extended by org.xmlBlaster.util.property.PropEntry
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
PropBoolean, PropDouble, PropInt, PropLong, PropString

public abstract class PropEntry
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Base class for the various property data type implementations.

Author:
xmlBlaster@marcelruff.info
See Also:
Serialized Form

Field Summary
static int CREATED_BY_CMDLINE
           
static int CREATED_BY_DEFAULT
           
static int CREATED_BY_JVMENV
           
static int CREATED_BY_PROPFILE
           
static int CREATED_BY_SETTER
           
protected  int creationOrigin
           
protected  java.lang.String propName
           
static java.lang.String SEP
           
 
Constructor Summary
PropEntry(java.lang.String propName)
          Constructor for the default value
 
Method Summary
 java.lang.Object clone()
          Returns a shallow clone.
abstract  java.lang.String getTypeString()
           
abstract  java.lang.String getValueString()
           
 boolean isDefault()
           
 boolean isModified()
          Is unmanipulated default value?
 boolean isSet()
           
 void setCreationOrigin(int creationOrigin)
           
 java.lang.String setFromEnv(Global glob, ContextNode contextNode, java.lang.String propName)
           
 java.lang.String setFromEnv(Global glob, java.lang.String nodeId, java.lang.String context, java.lang.String className, java.lang.String instanceName, java.lang.String propName)
          An environment is checked for a property.
 java.lang.String setFromEnv(Global glob, java.lang.String nodeId, java.lang.String context, java.lang.String className, java.lang.String instanceName, java.lang.String propName, boolean simpleLookup)
           
abstract  void setValue(java.lang.String value, int creationOrigin)
           
 java.lang.String toString()
           
 java.lang.String toXml()
          The literal XML string of the QoS
 java.lang.String toXml(java.lang.String extraOffset)
          Dump state of this object into a XML ASCII string.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SEP

public static final java.lang.String SEP
See Also:
Constant Field Values

CREATED_BY_DEFAULT

public static final int CREATED_BY_DEFAULT
See Also:
Constant Field Values

CREATED_BY_JVMENV

public static final int CREATED_BY_JVMENV
See Also:
Constant Field Values

CREATED_BY_PROPFILE

public static final int CREATED_BY_PROPFILE
See Also:
Constant Field Values

CREATED_BY_CMDLINE

public static final int CREATED_BY_CMDLINE
See Also:
Constant Field Values

CREATED_BY_SETTER

public static final int CREATED_BY_SETTER
See Also:
Constant Field Values

creationOrigin

protected int creationOrigin

propName

protected final java.lang.String propName
Constructor Detail

PropEntry

public PropEntry(java.lang.String propName)
Constructor for the default value

Method Detail

isModified

public final boolean isModified()
Is unmanipulated default value?


isDefault

public final boolean isDefault()

isSet

public final boolean isSet()

setCreationOrigin

public void setCreationOrigin(int creationOrigin)

getTypeString

public abstract java.lang.String getTypeString()
Returns:
e.g. "long" or "string"

getValueString

public abstract java.lang.String getValueString()
Returns:
The value in String form

setValue

public abstract void setValue(java.lang.String value,
                              int creationOrigin)
Parameters:
The - new value as String type, will be converted to native type
creationOrigin - e.g. PropEntry.CREATED_BY_JVMENV

setFromEnv

public final java.lang.String setFromEnv(Global glob,
                                         ContextNode contextNode,
                                         java.lang.String propName)

setFromEnv

public final java.lang.String setFromEnv(Global glob,
                                         java.lang.String nodeId,
                                         java.lang.String context,
                                         java.lang.String className,
                                         java.lang.String instanceName,
                                         java.lang.String propName)
An environment is checked for a property.
 "/node/frodo/client/joe/queue/history/maxEntries=10"

 nodeId='frodo'
 context='client/joe' or '/topic/HelloWorld'
 className='queue'
 instanceName='history'
 propName='maxEntries'
 
Old style:
 nodeId="heron" context="history.queue." propName="maxEntries" -> "history.queue.maxEntries[heron]"
 
Currently this precedence is supported:
  maxEntries                                         (weakest, not recommended)

  /node/heron/plugin/socket/port                     (recommended)

  queue/maxEntries                                   (supported until all is ported)

  queue/callback/maxEntries                          (recommended)

  /node/heron/queue/callback/maxEntries              (recommended in cluster)

  /node/heron/topic/hello/queue/callback/maxEntries  (strongest)
 

Returns:
the matching key

setFromEnv

public final java.lang.String setFromEnv(Global glob,
                                         java.lang.String nodeId,
                                         java.lang.String context,
                                         java.lang.String className,
                                         java.lang.String instanceName,
                                         java.lang.String propName,
                                         boolean simpleLookup)
Parameters:
simpleLookup - If false the given propName is not checked directly but only in its context (e.g. to avoid naming conflicts for simple properties like 'version'
Returns:
The found environment key which we used to set the property or "" if property was set by a setter (which has precedence)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toXml

public java.lang.String toXml()
The literal XML string of the QoS


toXml

public java.lang.String toXml(java.lang.String extraOffset)
Dump state of this object into a XML ASCII string.

Parameters:
extraOffset - indenting of tags for nice output
Returns:
internal state of the property as a XML ASCII string

clone

public java.lang.Object clone()
Returns a shallow clone.

Overrides:
clone in class java.lang.Object

xmlBlaster 2.2.0 client API

Copyright © 1999-2014 The xmlBlaster.org contributers.