Package org.appng.api.model
Interface Property
-
- All Known Implementing Classes:
PropertyImpl
,SimpleProperty
public interface Property
AProperty
is a single configuration value, used to configure the appNG platform, aSite
or aApplication
.- Author:
- Matthias Müller
- See Also:
Properties
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Property.Type
The type of aProperty
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description byte[]
getBlob()
If thisProperty
contains BLOB data, this data is being returned.Boolean
getBoolean()
Returns theBoolean
-value of thisProperty
:Boolean.TRUE
ifgetString()
returnstrue
or1
Boolean.FALSE
if thegetString()
returns a non-nullString
null
otherwiseString
getClob()
If thisProperty
contains CLOB data, this data is being returned.String
getDefaultString()
Returns the defaultString
-value of thisProperty
.String
getDescription()
Returns the description of thisProperty
.Double
getDouble()
Returns theDouble
-value of thisProperty
usingDouble.parseDouble(String)
, ifgetString()
returns a non-nullString
,null
otherwise.Float
getFloat()
Returns theFloat
-value of thisProperty
usingFloat.parseFloat(String)
, ifgetString()
returns a non-nullString
,null
otherwise.Integer
getInteger()
Returns theInteger
-value of thisProperty
usingInteger.parseInt(String)
, ifgetString()
returns a non-nullString
,null
otherwise.String
getName()
Returns the name of thisProperty
, as used inProperties.getXXX(String)
.String
getString()
Returns theString
-value of thisProperty
default Property.Type
getType()
Returns the type of this propertyboolean
isMandatory()
Deprecated.
-
-
-
Method Detail
-
getType
default Property.Type getType()
Returns the type of this property- Returns:
- the type
-
getString
String getString()
Returns theString
-value of thisProperty
- Returns:
- the
String
-value - See Also:
Properties.getString(String)
,Properties.getString(String, String)
-
getBoolean
Boolean getBoolean()
Returns theBoolean
-value of thisProperty
:Boolean.TRUE
ifgetString()
returnstrue
or1
Boolean.FALSE
if thegetString()
returns a non-nullString
null
otherwise
- Returns:
- the
Boolean
-value (may benull
) - See Also:
Properties.getBoolean(String)
,Properties.getBoolean(String, Boolean)
-
getInteger
Integer getInteger()
Returns theInteger
-value of thisProperty
usingInteger.parseInt(String)
, ifgetString()
returns a non-nullString
,null
otherwise.- Returns:
- the
Integer
-value (may benull
) - See Also:
Properties.getInteger(String)
,Properties.getInteger(String, Integer)
-
getFloat
Float getFloat()
Returns theFloat
-value of thisProperty
usingFloat.parseFloat(String)
, ifgetString()
returns a non-nullString
,null
otherwise.- Returns:
- the
Float
-value (may benull
) - See Also:
Properties.getFloat(String)
,Properties.getFloat(String, Float)
-
getDouble
Double getDouble()
Returns theDouble
-value of thisProperty
usingDouble.parseDouble(String)
, ifgetString()
returns a non-nullString
,null
otherwise.- Returns:
- the
Double
-value (may benull
) - See Also:
Properties.getDouble(String)
,Properties.getDouble(String, Double)
-
getBlob
byte[] getBlob()
If thisProperty
contains BLOB data, this data is being returned.- Returns:
- the BLOB data, (may be
null
) - See Also:
Properties.getBlob(String)
-
getClob
String getClob()
If thisProperty
contains CLOB data, this data is being returned.- Returns:
- the CLOB data, (may be
null
) - See Also:
Properties.getClob(String)
,Properties.getClob(String, String)
-
getName
String getName()
Returns the name of thisProperty
, as used inProperties.getXXX(String)
.- Returns:
- the name
-
isMandatory
@Deprecated boolean isMandatory()
Deprecated.
-
getDefaultString
String getDefaultString()
Returns the defaultString
-value of thisProperty
.- Returns:
- the default
String
-value
-
getDescription
String getDescription()
Returns the description of thisProperty
.- Returns:
- the description
-
-