SmartFrog 3.10.000

org.smartfrog.sfcore.reference
Interface ReferenceResolverHelper

All Known Subinterfaces:
ComponentDescription, CSFComponentDescription, Phases, SFComponentDescription
All Known Implementing Classes:
ComponentDescriptionImpl, CSFComponentDescriptionImpl, SFComponentDescriptionImpl

public interface ReferenceResolverHelper

This makes a reference resolver interface available for remotable objects. ReferenceResolver can not extend from Remote since RMI would then try to marshal a stub to component descriptions on the wire, thinking the description is remotable because it indirectly inherits Remote. Interfaces or classes that need to offer reference resolution and be serializable should implement ReferenceResolver while remotable classes or interfaces should implement RemoteReferenceResolver


Method Summary
 java.lang.Object sfResolve(Reference reference, boolean mandatory)
          Resolves given reference and gets a java Object.
 boolean sfResolve(Reference reference, boolean defaultValue, boolean mandatory)
          Resolves a reference and gets a boolean.
 ComponentDescription sfResolve(Reference reference, ComponentDescription defaultValue, boolean mandatory)
          Resolves given reference and gets a SmartFrog ComponentDescription.
 Compound sfResolve(Reference reference, Compound defaultValue, boolean mandatory)
          Resolves given reference and gets a SmartFrog Compound.
 double sfResolve(Reference reference, double defaultValue, boolean mandatory)
          Resolves given reference and gets a double.
 double sfResolve(Reference reference, double defaultValue, java.lang.Double minValue, java.lang.Double maxValue, boolean mandatory)
          Resolves given reference and gets a double.
 java.io.File sfResolve(Reference reference, java.io.File defaultValue, boolean mandatory)
          Resolves a given reference and gets a File.
 float sfResolve(Reference reference, float defaultValue, boolean mandatory)
          Resolves given reference and gets a float.
 float sfResolve(Reference reference, float defaultValue, java.lang.Float minValue, java.lang.Float maxValue, boolean mandatory)
          Resolves given reference and gets a float.
 java.net.InetAddress sfResolve(Reference reference, java.net.InetAddress defaultValue, boolean mandatory)
          Resolves given reference and gets a java.net.InetAddress.
 int sfResolve(Reference reference, int defaultValue, boolean mandatory)
          Resolves a given reference and gets an int.
 int sfResolve(Reference reference, int defaultValue, java.lang.Integer minValue, java.lang.Integer maxValue, boolean mandatory)
          Resolves a given reference and gets an int.
 long sfResolve(Reference reference, long defaultValue, boolean mandatory)
          Resolves given reference and gets a long.
 long sfResolve(Reference reference, long defaultValue, java.lang.Long minValue, java.lang.Long maxValue, boolean mandatory)
          Resolves given reference and gets a long.
 java.lang.Object sfResolve(Reference reference, java.lang.Object defaultValue, boolean mandatory)
          Resolves a given reference and gets a String[].
 Prim sfResolve(Reference reference, Prim defaultValue, boolean mandatory)
          Resolves given reference and gets a SmartFrog Prim.
 Reference sfResolve(Reference reference, Reference defaultValue, boolean mandatory)
          Resolves given reference and gets a SmartFrog Reference.
 java.lang.String[] sfResolve(Reference reference, java.lang.String[] defaultValue, boolean mandatory)
          Resolves a given reference and gets a String[].
 java.lang.String sfResolve(Reference reference, java.lang.String defaultValue, boolean mandatory)
          Resolves a given reference.
 java.net.URL sfResolve(Reference reference, java.net.URL defaultValue, boolean mandatory)
          Resolves given reference and gets a java.net.URL.
 java.util.Vector sfResolve(Reference reference, java.util.Vector defaultValue, boolean mandatory)
          Resolves a given reference and gets a Vector.
 java.lang.Object sfResolve(java.lang.String referencePart)
          Useful method since references are generally built up from strings.
 java.lang.Object sfResolve(java.lang.String referencePart, boolean mandatory)
          Resolves a reference given a string and gets an Object.
 boolean sfResolve(java.lang.String referencePart, boolean defaultValue, boolean mandatory)
          Resolves a reference given a string and gets a boolean.
 ComponentDescription sfResolve(java.lang.String referencePart, ComponentDescription defaultValue, boolean mandatory)
          Resolves a referencePart given a string and gets a SmartFrog ComponentDescription.
 Compound sfResolve(java.lang.String referencePart, Compound defaultValue, boolean mandatory)
          Resolves a referencePart given a string and gets a SmartFrog Compound.
 double sfResolve(java.lang.String referencePart, double defaultValue, boolean mandatory)
          Resolves a referencePart given a string and gets a double.
 double sfResolve(java.lang.String referencePart, double defaultValue, java.lang.Double minValue, java.lang.Double maxValue, boolean mandatory)
          Resolves a referencePart given a string and gets a double.
 java.io.File sfResolve(java.lang.String referencePart, java.io.File defaultValue, boolean mandatory)
          Resolves a reference given a String and gets a File.
 float sfResolve(java.lang.String referencePart, float defaultValue, boolean mandatory)
          Resolves a reference given a string and gets an float.
 float sfResolve(java.lang.String referencePart, float defaultValue, java.lang.Float minValue, java.lang.Float maxValue, boolean mandatory)
          Resolves a reference given a string and gets an float.
 java.net.InetAddress sfResolve(java.lang.String referencePart, java.net.InetAddress defaultValue, boolean mandatory)
          Resolves a referencePart given a string and gets a SmartFrog Reference.
 int sfResolve(java.lang.String referencePart, int defaultValue, boolean mandatory)
          Resolves a reference given a string and gets an int.
 int sfResolve(java.lang.String referencePart, int defaultValue, java.lang.Integer minValue, java.lang.Integer maxValue, boolean mandatory)
          Resolves a reference given a string and gets an int.
 long sfResolve(java.lang.String referencePart, long defaultValue, boolean mandatory)
          Resolves a referencePart given a string and gets a long.
 long sfResolve(java.lang.String referencePart, long defaultValue, java.lang.Long minValue, java.lang.Long maxValue, boolean mandatory)
          Resolves a referencePart given a string and gets a long.
 java.lang.Object sfResolve(java.lang.String referencePart, java.lang.Object defaultValue, boolean mandatory)
          Resolves a reference given a string and gets an Object.
 Prim sfResolve(java.lang.String referencePart, Prim defaultValue, boolean mandatory)
          Resolves a referencePart given a string and gets a SmartFrog Prim.
 Reference sfResolve(java.lang.String referencePart, Reference defaultValue, boolean mandatory)
          Resolves a referencePart given a string and gets a SmartFrog Reference.
 java.lang.String[] sfResolve(java.lang.String referencePart, java.lang.String[] defaultValue, boolean mandatory)
          Resolves a reference given a string and gets a String[].
 java.lang.String sfResolve(java.lang.String referencePart, java.lang.String defaultValue, boolean mandatory)
          Resolves a reference given a String and gets a String.
 java.net.URL sfResolve(java.lang.String referencePart, java.net.URL defaultValue, boolean mandatory)
          Resolves a referencePart given a string and gets a SmartFrog Reference.
 java.util.Vector sfResolve(java.lang.String referencePart, java.util.Vector defaultValue, boolean mandatory)
          Resolves a reference given a string and gets Vector.
 java.lang.Object sfResolveHere(java.lang.Object name, boolean mandatory)
          Find an attribute in this context.
 java.lang.Object sfResolveWithParser(java.lang.String reference)
          Resolves a reference given a string.
 

Method Detail

sfResolveHere

java.lang.Object sfResolveHere(java.lang.Object name,
                               boolean mandatory)
                               throws SmartFrogResolutionException
Find an attribute in this context.

Parameters:
name - attribute key to resolve
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it throws a SmartFrogResolutionException
Returns:
Object value for attribute
Throws:
SmartFrogResolutionException - failed to find attribute

sfResolve

java.lang.Object sfResolve(java.lang.String referencePart)
                           throws SmartFrogResolutionException
Useful method since references are generally built up from strings. This will translate the string into a reference with a single part and resolve it. If the reference is illegal (ie. not parseable) a illegal reference resolution exception is thrown

Parameters:
referencePart - string representation of reference to resolve
Returns:
the resolved object
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable
SmartFrogResolutionException - if there is any network/rmi error

sfResolveWithParser

java.lang.Object sfResolveWithParser(java.lang.String reference)
                                     throws SmartFrogResolutionException
Resolves a reference given a string. Utility method to auto-convert from string to reference. It can use cannonical representations for reference that are resolved by the parser.

Parameters:
reference - string field reference
Returns:
the resolved object
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable
SmartFrogResolutionException - if there is any network/rmi error

sfResolve

java.lang.Object sfResolve(Reference reference,
                           boolean mandatory)
                           throws SmartFrogResolutionException
Resolves given reference and gets a java Object. Utility method to resolve an attribute with a java Object value.

Parameters:
reference - reference
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it thows a SmartFrogResolutionException
Returns:
java Object for attribute value or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

java.lang.Object sfResolve(java.lang.String referencePart,
                           boolean mandatory)
                           throws SmartFrogResolutionException
Resolves a reference given a string and gets an Object. Utility method to resolve an attribute with a Object value and returns a Object.

Parameters:
referencePart - string field reference with single part
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
java Object for attribute value or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

boolean sfResolve(Reference reference,
                  boolean defaultValue,
                  boolean mandatory)
                  throws SmartFrogResolutionException
Resolves a reference and gets a boolean. Utility method to resolve an attribute with a boolean value.

Parameters:
reference - reference
defaultValue - boolean default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
boolean for attribute value or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

int sfResolve(Reference reference,
              int defaultValue,
              boolean mandatory)
              throws SmartFrogResolutionException
Resolves a given reference and gets an int. Utility method to resolve an attribute with an int value.

Parameters:
reference - reference
defaultValue - int default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
int for attribute value or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

int sfResolve(Reference reference,
              int defaultValue,
              java.lang.Integer minValue,
              java.lang.Integer maxValue,
              boolean mandatory)
              throws SmartFrogResolutionException
Resolves a given reference and gets an int. Utility method to resolve an attribute with an int value.

Parameters:
reference - reference
defaultValue - int default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
minValue - allowed (included).
maxValue - allowd (included).
Returns:
int for attribute value or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable or resolve value <minValue or resolveValue >maxValue

sfResolve

long sfResolve(Reference reference,
               long defaultValue,
               boolean mandatory)
               throws SmartFrogResolutionException
Resolves given reference and gets a long. Utility method to resolve an attribute with an long value. Int values are "upcasted" to long.

Parameters:
reference - reference
defaultValue - long default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
long for attribute value or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

long sfResolve(Reference reference,
               long defaultValue,
               java.lang.Long minValue,
               java.lang.Long maxValue,
               boolean mandatory)
               throws SmartFrogResolutionException
Resolves given reference and gets a long. Utility method to resolve an attribute with an long value. Int values are "upcasted" to long.

Parameters:
reference - reference
defaultValue - long default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
minValue - allowed (included)
maxValue - allowed (included)
Returns:
long for attribute value or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable or resolve value <minValue or resolveValue >maxValue

sfResolve

float sfResolve(Reference reference,
                float defaultValue,
                boolean mandatory)
                throws SmartFrogResolutionException
Resolves given reference and gets a float. Utility method to resolve an attribute with an float value. Int values are "upcasted" to float.

Parameters:
reference - reference
defaultValue - float default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
float for attribute value or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

float sfResolve(Reference reference,
                float defaultValue,
                java.lang.Float minValue,
                java.lang.Float maxValue,
                boolean mandatory)
                throws SmartFrogResolutionException
Resolves given reference and gets a float. Utility method to resolve an attribute with an float value. Int values are "upcasted" to float.

Parameters:
reference - reference
defaultValue - float default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
minValue - allowed (included)
maxValue - allowed (included)
Returns:
float for attribute value or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable or resolve value <minValue or resolveValue >maxValue

sfResolve

double sfResolve(Reference reference,
                 double defaultValue,
                 boolean mandatory)
                 throws SmartFrogResolutionException
Resolves given reference and gets a double. Utility method to resolve an attribute with an double value. Int, Long and Float values are "upcasted" to double.

Parameters:
reference - reference
defaultValue - double default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
double for attribute value or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable or resolve value <minValue or resolveValue >maxValue

sfResolve

double sfResolve(Reference reference,
                 double defaultValue,
                 java.lang.Double minValue,
                 java.lang.Double maxValue,
                 boolean mandatory)
                 throws SmartFrogResolutionException
Resolves given reference and gets a double. Utility method to resolve an attribute with an double value. Int, Long and float values are "upcasted" to double.

Parameters:
reference - reference
defaultValue - double default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
minValue - allowed (included)
maxValue - allowed (included)
Returns:
double for attribute value or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable or resolve value <minValue or resolveValue >maxValue

sfResolve

java.lang.String sfResolve(Reference reference,
                           java.lang.String defaultValue,
                           boolean mandatory)
                           throws SmartFrogResolutionException
Resolves a given reference. Utility method to resolve an attribute with a String value.

Parameters:
reference - reference
defaultValue - String default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
String for attribute value, null if SFNull is found or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

java.util.Vector sfResolve(Reference reference,
                           java.util.Vector defaultValue,
                           boolean mandatory)
                           throws SmartFrogResolutionException
Resolves a given reference and gets a Vector. Utility method to resolve an attribute with a Vector value.

Parameters:
reference - reference
defaultValue - Vector default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
Vector for attribute value, null if SFNull is found or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

java.lang.String[] sfResolve(Reference reference,
                             java.lang.String[] defaultValue,
                             boolean mandatory)
                             throws SmartFrogResolutionException
Resolves a given reference and gets a String[]. Utility method to resolve an attribute with a Vector value and returns a String[].

Parameters:
reference - reference
defaultValue - String[] default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
String[] for attribute value, null if SFNull is found or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

java.io.File sfResolve(Reference reference,
                       java.io.File defaultValue,
                       boolean mandatory)
                       throws SmartFrogResolutionException
Resolves a given reference and gets a File. Utility method to resolve an attribute with a String value and returns a File.

Parameters:
reference - reference
defaultValue - File default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
java.io.File for attribute value, null if SFNull is found or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

java.net.InetAddress sfResolve(Reference reference,
                               java.net.InetAddress defaultValue,
                               boolean mandatory)
                               throws SmartFrogResolutionException
Resolves given reference and gets a java.net.InetAddress. Utility method to resolve an attribute with a java.net.InetAddress value.

Parameters:
reference - reference
defaultValue - java.net.InetAddress default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
java.net.InetAddress for attribute value, null if SFNull is found or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

java.net.URL sfResolve(Reference reference,
                       java.net.URL defaultValue,
                       boolean mandatory)
                       throws SmartFrogResolutionException
Resolves given reference and gets a java.net.URL. Utility method to resolve an attribute with a java.net.URL value.

Parameters:
reference - reference
defaultValue - java.net.URL default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
java.net.URL for attribute value, null if SFNull is found or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

ComponentDescription sfResolve(Reference reference,
                               ComponentDescription defaultValue,
                               boolean mandatory)
                               throws SmartFrogResolutionException
Resolves given reference and gets a SmartFrog ComponentDescription. Utility method to resolve an attribute with a SmartFrog ComponentDescription value.

Parameters:
reference - reference
defaultValue - SmartFrog ComponentDescription default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
SmartFrog ComponentDescription for attribute value, null if SFNull is found or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

Reference sfResolve(Reference reference,
                    Reference defaultValue,
                    boolean mandatory)
                    throws SmartFrogResolutionException
Resolves given reference and gets a SmartFrog Reference. Utility method to resolve an attribute with a SmartFrog Reference value.

Parameters:
reference - reference
defaultValue - SmartFrog Reference default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
SmartFrog Reference for attribute value, null if SFNull is found or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

Prim sfResolve(Reference reference,
               Prim defaultValue,
               boolean mandatory)
               throws SmartFrogResolutionException
Resolves given reference and gets a SmartFrog Prim. Utility method to resolve an attribute with a SmartFrog Prim value.

Parameters:
reference - reference
defaultValue - SmartFrog Prim default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
SmartFrog Prim for attribute value, null if SFNull is found or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

Compound sfResolve(Reference reference,
                   Compound defaultValue,
                   boolean mandatory)
                   throws SmartFrogResolutionException
Resolves given reference and gets a SmartFrog Compound. Utility method to resolve an attribute with a SmartFrog Compound value.

Parameters:
reference - reference
defaultValue - SmartFrog Compound default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
SmartFrog Compound for attribute value, null if SFNull is found or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

java.lang.Object sfResolve(Reference reference,
                           java.lang.Object defaultValue,
                           boolean mandatory)
                           throws SmartFrogResolutionException
Resolves a given reference and gets a String[]. Utility method to resolve an attribute with a Vector value and returns a String[].

Parameters:
reference - reference
defaultValue - String[] default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
String[] for attribute value, null if SFNull is found or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

boolean sfResolve(java.lang.String referencePart,
                  boolean defaultValue,
                  boolean mandatory)
                  throws SmartFrogResolutionException
Resolves a reference given a string and gets a boolean. Utility method to resolve an attribute with a boolean value.

Parameters:
referencePart - string field reference with single part
defaultValue - boolean default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
boolean for attribute value or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

int sfResolve(java.lang.String referencePart,
              int defaultValue,
              boolean mandatory)
              throws SmartFrogResolutionException
Resolves a reference given a string and gets an int. Utility method to resolve an attribute with an int value.

Parameters:
referencePart - string field reference with single part
defaultValue - int default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
int for attribute value or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

int sfResolve(java.lang.String referencePart,
              int defaultValue,
              java.lang.Integer minValue,
              java.lang.Integer maxValue,
              boolean mandatory)
              throws SmartFrogResolutionException
Resolves a reference given a string and gets an int. Utility method to resolve an attribute with an int value.

Parameters:
referencePart - string field reference with single part
defaultValue - int default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
minValue - allowed (included)
maxValue - allowed (included)
Returns:
int for attribute value or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable or resolve value <minValue or resolveValue >maxValue

sfResolve

long sfResolve(java.lang.String referencePart,
               long defaultValue,
               boolean mandatory)
               throws SmartFrogResolutionException
Resolves a referencePart given a string and gets a long. Utility method to resolve an attribute with an long value. Int values are upcastted to long.

Parameters:
referencePart - string field reference
defaultValue - long default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
long for attribute value or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

long sfResolve(java.lang.String referencePart,
               long defaultValue,
               java.lang.Long minValue,
               java.lang.Long maxValue,
               boolean mandatory)
               throws SmartFrogResolutionException
Resolves a referencePart given a string and gets a long. Utility method to resolve an attribute with an long value. Int values are upcastted to long.

Parameters:
referencePart - string field reference
defaultValue - long default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
minValue - allowed (included)
maxValue - allowed (included)
Returns:
long for attribute value or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable or resolve value <minValue or resolveValue >maxValue

sfResolve

float sfResolve(java.lang.String referencePart,
                float defaultValue,
                boolean mandatory)
                throws SmartFrogResolutionException
Resolves a reference given a string and gets an float. Utility method to resolve an attribute with an float value. Int is "upcasted" to float.

Parameters:
referencePart - string field reference with single part
defaultValue - float default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
float for attribute value or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable or resolve value <minValue or resolveValue >maxValue

sfResolve

float sfResolve(java.lang.String referencePart,
                float defaultValue,
                java.lang.Float minValue,
                java.lang.Float maxValue,
                boolean mandatory)
                throws SmartFrogResolutionException
Resolves a reference given a string and gets an float. Utility method to resolve an attribute with an float value. Int is "upcasted to float.

Parameters:
referencePart - string field reference with single part
defaultValue - float default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
minValue - allowed (included)
maxValue - allowed (included)
Returns:
float for attribute value or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable or resolve value <minValue or resolveValue >maxValue

sfResolve

double sfResolve(java.lang.String referencePart,
                 double defaultValue,
                 boolean mandatory)
                 throws SmartFrogResolutionException
Resolves a referencePart given a string and gets a double. Utility method to resolve an attribute with an double value. Int, Long and Float values are upcasted to double.

Parameters:
referencePart - string field reference
defaultValue - double default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
double for attribute value or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable or resolve value <minValue or resolveValue >maxValue

sfResolve

double sfResolve(java.lang.String referencePart,
                 double defaultValue,
                 java.lang.Double minValue,
                 java.lang.Double maxValue,
                 boolean mandatory)
                 throws SmartFrogResolutionException
Resolves a referencePart given a string and gets a double. Utility method to resolve an attribute with an double value. Int, Long and Float values are upcasted to double.

Parameters:
referencePart - string field reference
defaultValue - double default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
minValue - allowed (included)
maxValue - allowed (included)
Returns:
double for attribute value or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable or resolve value <minValue or resolveValue >maxValue

sfResolve

java.lang.String sfResolve(java.lang.String referencePart,
                           java.lang.String defaultValue,
                           boolean mandatory)
                           throws SmartFrogResolutionException
Resolves a reference given a String and gets a String. Utility method to resolve an attribute with a String value.

Parameters:
referencePart - string field reference with single part
defaultValue - String default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
String for attribute value, null if SFNull is found or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

java.util.Vector sfResolve(java.lang.String referencePart,
                           java.util.Vector defaultValue,
                           boolean mandatory)
                           throws SmartFrogResolutionException
Resolves a reference given a string and gets Vector. Utility method to resolve an attribute with a Vector value.

Parameters:
referencePart - string field reference with single part
defaultValue - Vector default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
Vector for attribute value, null if SFNull is found or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

java.io.File sfResolve(java.lang.String referencePart,
                       java.io.File defaultValue,
                       boolean mandatory)
                       throws SmartFrogResolutionException
Resolves a reference given a String and gets a File. Utility method to resolve an attribute with a String value.

Parameters:
referencePart - string field reference with single part
defaultValue - String default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
String for attribute value, null if SFNull is found or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable or File does not exists.

sfResolve

java.lang.String[] sfResolve(java.lang.String referencePart,
                             java.lang.String[] defaultValue,
                             boolean mandatory)
                             throws SmartFrogResolutionException
Resolves a reference given a string and gets a String[]. Utility method to resolve an attribute with a Vector value and returns a String[].

Parameters:
referencePart - string field reference with single part
defaultValue - String[] default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
String[] for attribute value, null if SFNull is found or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

java.net.InetAddress sfResolve(java.lang.String referencePart,
                               java.net.InetAddress defaultValue,
                               boolean mandatory)
                               throws SmartFrogResolutionException
Resolves a referencePart given a string and gets a SmartFrog Reference. Utility method to resolve an attribute with a java.net.InetAddress value.

Parameters:
referencePart - string field reference
defaultValue - java.net.InetAddress default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
java.net.InetAddress for attribute value, null if SFNull is found or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

java.net.URL sfResolve(java.lang.String referencePart,
                       java.net.URL defaultValue,
                       boolean mandatory)
                       throws SmartFrogResolutionException
Resolves a referencePart given a string and gets a SmartFrog Reference. Utility method to resolve an attribute with a java.net.URL value.

Parameters:
referencePart - string field reference
defaultValue - java.net.URL default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
java.net.URL for attribute value, null if SFNull is found or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

ComponentDescription sfResolve(java.lang.String referencePart,
                               ComponentDescription defaultValue,
                               boolean mandatory)
                               throws SmartFrogResolutionException
Resolves a referencePart given a string and gets a SmartFrog ComponentDescription. Utility method to resolve an attribute with a SmartFrog ComponentDescription value.

Parameters:
referencePart - string field reference
defaultValue - SmartFrog ComponentDescription default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
ComponentDescription for attribute value, null if SFNull is found or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

Reference sfResolve(java.lang.String referencePart,
                    Reference defaultValue,
                    boolean mandatory)
                    throws SmartFrogResolutionException
Resolves a referencePart given a string and gets a SmartFrog Reference. Utility method to resolve an attribute with a SmartFrog Reference value.

Parameters:
referencePart - string field reference
defaultValue - SmartFrog Reference default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
Reference for attribute value, null if SFNull is found or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

Prim sfResolve(java.lang.String referencePart,
               Prim defaultValue,
               boolean mandatory)
               throws SmartFrogResolutionException
Resolves a referencePart given a string and gets a SmartFrog Prim. Utility method to resolve an attribute with a SmartFrog Prim value.

Parameters:
referencePart - string field reference
defaultValue - SmartFrog Prim default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
Prim for attribute value, null if SFNull is found or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

Compound sfResolve(java.lang.String referencePart,
                   Compound defaultValue,
                   boolean mandatory)
                   throws SmartFrogResolutionException
Resolves a referencePart given a string and gets a SmartFrog Compound. Utility method to resolve an attribute with a SmartFrog Compound value.

Parameters:
referencePart - string field reference
defaultValue - SmartFrog Compound default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException
Returns:
Compound for attribute value, null if SFNull is found or defaultValue if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

sfResolve

java.lang.Object sfResolve(java.lang.String referencePart,
                           java.lang.Object defaultValue,
                           boolean mandatory)
                           throws SmartFrogResolutionException
Resolves a reference given a string and gets an Object. Utility method to resolve an attribute with a Object value and returns a Object.

Parameters:
referencePart - string field reference with single part
defaultValue - any java Object default value that is returned when reference is not found and it is not mandatory
mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException
Returns:
java Object for attribute value, null if SFNull is found or null if not found
Throws:
SmartFrogResolutionException - if invalid reference of reference not resolvable

SmartFrog CORE 3.10.000

(C) Copyright 1998-2006 Hewlett-Packard Development Company, LP