CmsJspObjectValueWrapper (OpenCms Core API, version 11.0.0)

java.lang.Object
- java.util.AbstractCollection<java.lang.String>
- - org.opencms.jsp.util.CmsJspObjectValueWrapper

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>, java.util.Collection<java.lang.String>
```
public final class CmsJspObjectValueWrapper
extends java.util.AbstractCollection<java.lang.String>
```
Provides access to common object types through wrappers.

Since:

11.0

Field Summary

Fields
Modifier and Type	Field and Description
`protected CmsObject`	`m_cms` The wrapped OpenCms user context.
`protected static CmsJspObjectValueWrapper`	`NULL_VALUE_WRAPPER` Constant for the null (non existing) value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static CmsJspObjectValueWrapper`	`createWrapper(CmsObject cms, java.lang.Object value)` Factory method to create a new XML content value wrapper.
`boolean`	`equals(java.lang.Object obj)`
`CmsObject`	`getCmsObject()` Returns the current cms context.
`java.util.Map<java.lang.Object,java.lang.Boolean>`	`getContains()` Returns a lazy initialized Map that provides Booleans which indicate if if the wrapped values String representation contains a specific String.
`boolean`	`getExists()` Returns `true` in case there was an object wrapped.
`boolean`	`getIsEmpty()` Returns `true` in case the object is empty, that is either `null` or an empty String.
`boolean`	`getIsEmptyOrWhitespaceOnly()` Returns `true` in case the object is empty or whitespace only, that is either `null` or an empty String.
`java.util.Map<java.lang.Object,java.lang.Boolean>`	`getIsEqual()` Returns a lazy initialized Map that provides Booleans which indicate if an Object is equal to the wrapped object.
`boolean`	`getIsSet()` Returns `true` in case the wrapped value exists and is not empty or whitespace only.
`boolean`	`getIsSetNotNone()` Returns `true` in case the wrapped value exists, is not empty or whitespace only and is also not equal to the String `'none'`.
`java.lang.Long`	`getMathCeil()` Calculates the next largest integer from the wrapped value.
`java.lang.Long`	`getMathFloor()` Calculates the next smallest integer from the wrapped value.
`java.lang.Long`	`getMathRound()` Calculates the next integer from the wrapped value by rounding.
`java.lang.Object`	`getObjectValue()` Returns the wrapped object value.
`java.lang.String`	`getStringValue()` Deprecated. use `getToString()` instead
`java.lang.String`	`getStripHtml()` Assumes the wrapped value is a String and strips all HTML markup from this String.
`boolean`	`getToBoolean()` Converts the wrapped value to a boolean.
`java.util.Date`	`getToDate()` Converts the wrapped value to a date.
`java.lang.Double`	`getToDouble()` Parses the wrapped value to a Double precision float.
`java.lang.Double`	`getToFloat()` Parses the wrapped value to a Double precision float.
`CmsJspImageBean`	`getToImage()` Returns a scaled image bean from the wrapped value.
`CmsJspInstanceDateBean`	`getToInstanceDate()` Converts a date to an instance date bean.
`java.lang.Long`	`getToInteger()` Parses the wrapped value to a Long integer.
`java.lang.String`	`getToLink()` Returns the substituted link to the wrapped value.
`java.lang.Long`	`getToLong()` Parses the wrapped value to a Long integer.
`CmsJspResourceWrapper`	`getToResource()` Converts a date to an instance date bean.
`java.lang.String`	`getToString()` Returns the wrapped value as a String.
`java.util.Map<java.lang.Object,java.lang.String>`	`getTrimToSize()` Returns a lazy initialized map that provides trimmed to size strings of the wrapped object string value.
`int`	`hashCode()`
`boolean`	`isEmpty()` Supports the use of the `empty` operator in the JSP EL by implementing the Collection interface.
`java.util.Iterator<java.lang.String>`	`iterator()` Supports the use of the `empty` operator in the JSP EL by implementing the Collection interface.
`int`	`size()` Supports the use of the `empty` operator in the JSP EL by implementing the Collection interface.
`protected static java.lang.String`	`substituteLink(CmsObject cms, java.lang.String target)` Returns the substituted link to the given target.
`java.lang.Double`	`toDouble(java.lang.Double def)` Parses the wrapped value to a Double precision float, returning the default in case the number can not be parsed.
`java.lang.Double`	`toFloat(java.lang.Double def)` Parses the wrapped value to a Double precision float, returning the default in case the number can not be parsed.
`java.lang.Long`	`toInteger(java.lang.Long def)` Parses the wrapped value to a Long integer, returning the default in case the number can not be parsed.
`java.lang.Long`	`toLong(java.lang.Long def)` Parses the wrapped value to a Long integer, returning the default in case the number can not be parsed.
`java.lang.String`	`toString()`

Methods inherited from class java.util.AbstractCollection
add, addAll, clear, contains, containsAll, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection
parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - NULL_VALUE_WRAPPER
```
protected static final CmsJspObjectValueWrapper NULL_VALUE_WRAPPER
```
    Constant for the null (non existing) value.
  - m_cms
```
protected CmsObject m_cms
```
    The wrapped OpenCms user context.
- Method Detail
  - createWrapper
```
public static CmsJspObjectValueWrapper createWrapper(CmsObject cms,
                                                     java.lang.Object value)
```
    Factory method to create a new XML content value wrapper.
    In case either parameter is null, the NULL_VALUE_WRAPPER is returned.
    
    Parameters:
    
    cms - the current users OpenCms context
    
    value - the object to warp
    
    Returns:
    
    a new content value wrapper instance, or null if any parameter is null
  - getExists
```
public boolean getExists()
```
    Returns true in case there was an object wrapped.
    
    Returns:
    
    true in case there was an object wrapped
  - getIsEmpty
```
public boolean getIsEmpty()
```
    Returns true in case the object is empty, that is either null or an empty String.
    In case the object does not exist, true is returned.
    
    Returns:
    
    true in case the object is empty
  - getIsEmptyOrWhitespaceOnly
```
public boolean getIsEmptyOrWhitespaceOnly()
```
    Returns true in case the object is empty or whitespace only, that is either null or an empty String.
    In case the object does not exist, true is returned.
    
    Returns:
    
    true in case the object is empty
  - getObjectValue
```
public java.lang.Object getObjectValue()
```
    Returns the wrapped object value.
    
    Returns:
    
    the wrapped object value
  - getToDate
```
public java.util.Date getToDate()
```
    Converts the wrapped value to a date. Keeps it as date, if it already is one.
    
    Returns:
    
    the date
    
    See Also:
    
    A_CmsJspValueWrapper.getToDate()
  - getToResource
```
public CmsJspResourceWrapper getToResource()
```
    Converts a date to an instance date bean.
    
    Returns:
    
    the instance date bean.
    
    See Also:
    
    A_CmsJspValueWrapper.getToResource()
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Collection<java.lang.String>
    
    See Also:
    
    Object.hashCode()
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.util.AbstractCollection<java.lang.String>
    
    See Also:
    
    Object.toString()
  - substituteLink
```
protected static java.lang.String substituteLink(CmsObject cms,
                                                 java.lang.String target)
```
    Returns the substituted link to the given target.
    
    Parameters:
    
    cms - the cms context
    
    target - the link target
    
    Returns:
    
    the substituted link
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Specified by:
    
    equals in interface java.util.Collection<java.lang.String>
    
    Overrides:
    
    equals in class java.lang.Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - getCmsObject
```
public CmsObject getCmsObject()
```
    Returns the current cms context.
    
    Returns:
    
    the cms context
  - getContains
```
public java.util.Map<java.lang.Object,java.lang.Boolean> getContains()
```
    Returns a lazy initialized Map that provides Booleans which indicate if if the wrapped values String representation contains a specific String.
    The Object parameter is transformed to it's String representation to perform this check.
    
    Returns:
    
    a lazy initialized Map that provides Booleans which indicate if if the wrapped values String representation contains a specific String
  - getIsEqual
```
public java.util.Map<java.lang.Object,java.lang.Boolean> getIsEqual()
```
    Returns a lazy initialized Map that provides Booleans which indicate if an Object is equal to the wrapped object.
    
    Returns:
    
    a lazy initialized Map that provides Booleans which indicate if an Object is equal to the wrapped object
  - getIsSet
```
public boolean getIsSet()
```
    Returns true in case the wrapped value exists and is not empty or whitespace only.
    
    Returns:
    
    true in case the wrapped value exists and is not empty or whitespace only
  - getIsSetNotNone
```
public boolean getIsSetNotNone()
```
    Returns true in case the wrapped value exists, is not empty or whitespace only and is also not equal to the String 'none'.
    
    Returns:
    
    true in case the wrapped value exists, is not empty or whitespace only and is also not equal to the String 'none'
  - getMathCeil
```
public java.lang.Long getMathCeil()
```
    Calculates the next largest integer from the wrapped value.
    Note that the result is an Object of type Long, so in case the wrapped value can not be converted to a number, null is returned. This means you can check for an empty result in the EL.
    
    Returns:
    
    the next largest integer for the wrapped value
  - getMathFloor
```
public java.lang.Long getMathFloor()
```
    Calculates the next smallest integer from the wrapped value.
    Note that the result is an Object of type Long, so in case the wrapped value can not be converted to a number, null is returned. This means you can check for an empty result in the EL.
    
    Returns:
    
    the next smallest integer for the wrapped value
  - getMathRound
```
public java.lang.Long getMathRound()
```
    Calculates the next integer from the wrapped value by rounding.
    Note that the result is an Object of type Long, so in case the wrapped value can not be converted to a number, null is returned. This means you can check for an empty result in the EL.
    
    Returns:
    
    the next integer for the wrapped value calculated by rounding
  - getStringValue
```
@Deprecated
public java.lang.String getStringValue()
```
    Deprecated. use getToString() instead
    
    Returns the String value for the wrapped content value.
    This will return the empty String "" when getExists() returns false
    .
    
    Returns:
    
    the String value of the wrapped content value
  - getStripHtml
```
public java.lang.String getStripHtml()
```
    Assumes the wrapped value is a String and strips all HTML markup from this String.
    
    Returns:
    
    the wrapped value with all HTML stripped.
  - getToBoolean
```
public boolean getToBoolean()
```
    Converts the wrapped value to a boolean.
    
    Returns:
    
    the boolean value
  - getToDouble
```
public java.lang.Double getToDouble()
```
    Parses the wrapped value to a Double precision float.
    Note that the result is an Object of type Double, so in case the wrapped value can not be converted to a number, null is returned. This means you can check for an empty result in the EL.
    
    Returns:
    
    the Double precision float value
  - getToFloat
```
public java.lang.Double getToFloat()
```
    Parses the wrapped value to a Double precision float.
    Note that the result is an Object of type Double, so in case the wrapped value can not be converted to a number, null is returned. This means you can check for an empty result in the EL.
    
    Returns:
    
    the Double precision float value
  - getToImage
```
public CmsJspImageBean getToImage()
```
    Returns a scaled image bean from the wrapped value.
    In case the value does not point to an image resource, null is returned.
    
    Returns:
    
    the scaled image bean
  - getToInstanceDate
```
public CmsJspInstanceDateBean getToInstanceDate()
```
    Converts a date to an instance date bean.
    
    Returns:
    
    the instance date bean.
  - getToInteger
```
public java.lang.Long getToInteger()
```
    Parses the wrapped value to a Long integer.
    Note that the result is an Object of type Long, so in case the wrapped value can not be converted to a number, null is returned. This means you can check for an empty result in the EL.
    
    Returns:
    
    the Long integer value
    
    See Also:
    
    getToLong()
  - getToLink
```
public java.lang.String getToLink()
```
    Returns the substituted link to the wrapped value.
    In case no link can be substituted from the wrapped value, an empty String "" is returned.
    
    Returns:
    
    the substituted link
  - getToLong
```
public java.lang.Long getToLong()
```
    Parses the wrapped value to a Long integer.
    Note that the result is an Object of type Long, so in case the wrapped value can not be converted to a number, null is returned. This means you can check for an empty result in the EL.
    
    Returns:
    
    the Long integer value
    
    See Also:
    
    getToInteger()
  - getToString
```
public java.lang.String getToString()
```
    Returns the wrapped value as a String.
    This will always be at least an empty String "", never null.
    
    Returns:
    
    the wrapped value as a String
  - getTrimToSize
```
public java.util.Map<java.lang.Object,java.lang.String> getTrimToSize()
```
    Returns a lazy initialized map that provides trimmed to size strings of the wrapped object string value. The size being the integer value of the key object.
    
    Returns:
    
    a map that provides trimmed to size strings of the wrapped object string value
  - isEmpty
```
public boolean isEmpty()
```
    Supports the use of the empty operator in the JSP EL by implementing the Collection interface.
    
    Specified by:
    
    isEmpty in interface java.util.Collection<java.lang.String>
    
    Overrides:
    
    isEmpty in class java.util.AbstractCollection<java.lang.String>
    
    Returns:
    
    the value from getIsEmptyOrWhitespaceOnly() which is the inverse of getIsSet().
    
    See Also:
    
    AbstractCollection.isEmpty(), getIsEmptyOrWhitespaceOnly(), getIsSet()
  - iterator
```
public java.util.Iterator<java.lang.String> iterator()
```
    Supports the use of the empty operator in the JSP EL by implementing the Collection interface.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.String>
    
    Specified by:
    
    iterator in interface java.util.Collection<java.lang.String>
    
    Specified by:
    
    iterator in class java.util.AbstractCollection<java.lang.String>
    
    Returns:
    
    an empty Iterator in case isEmpty() is true, otherwise an Iterator that will return the String value of this wrapper exactly once.
    
    See Also:
    
    AbstractCollection.size()
  - size
```
public int size()
```
    Supports the use of the empty operator in the JSP EL by implementing the Collection interface.
    
    Specified by:
    
    size in interface java.util.Collection<java.lang.String>
    
    Specified by:
    
    size in class java.util.AbstractCollection<java.lang.String>
    
    Returns:
    
    always returns 0.
    
    See Also:
    
    AbstractCollection.size()
  - toDouble
```
public java.lang.Double toDouble(java.lang.Double def)
```
    Parses the wrapped value to a Double precision float, returning the default in case the number can not be parsed.
    
    Parameters:
    
    def - the default in case the wrapped value can not be converted to a number
    
    Returns:
    
    a Double precision float value
    
    See Also:
    
    toFloat(Double)
  - toFloat
```
public java.lang.Double toFloat(java.lang.Double def)
```
    Parses the wrapped value to a Double precision float, returning the default in case the number can not be parsed.
    
    Parameters:
    
    def - the default in case the wrapped value can not be converted to a number
    
    Returns:
    
    a Double precision float value
    
    See Also:
    
    toDouble(Double)
  - toInteger
```
public java.lang.Long toInteger(java.lang.Long def)
```
    Parses the wrapped value to a Long integer, returning the default in case the number can not be parsed.
    
    Parameters:
    
    def - the default in case the wrapped value can not be converted to a number
    
    Returns:
    
    a Long integer value
    
    See Also:
    
    toLong(Long)
  - toLong
```
public java.lang.Long toLong(java.lang.Long def)
```
    Parses the wrapped value to a Long integer, returning the default in case the number can not be parsed.
    
    Parameters:
    
    def - the default in case the wrapped value can not be converted to a number
    
    Returns:
    
    a Long integer value
    
    See Also:
    
    toInteger(Long)

Class CmsJspObjectValueWrapper

Field Summary

Method Summary

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

NULL_VALUE_WRAPPER

m_cms

Method Detail

createWrapper

getExists

getIsEmpty

getIsEmptyOrWhitespaceOnly

getObjectValue

getToDate

getToResource

hashCode

toString

substituteLink

equals

getCmsObject

getContains

getIsEqual

getIsSet

getIsSetNotNone

getMathCeil

getMathFloor

getMathRound

getStringValue

getStripHtml

getToBoolean

getToDouble

getToFloat

getToImage

getToInstanceDate

getToInteger

getToLink

getToLong

getToString

getTrimToSize

isEmpty

iterator

size

toDouble

toFloat

toInteger

toLong