org.onehippo.cms7.crisp.api.resource

Interface ValueMap

All Superinterfaces:

Map<String,Object>, Serializable

All Known Implementing Classes:

AbstractValueMap, DefaultValueMap

public interface ValueMap
extends Map<String,Object>, Serializable

ValueMap is an easy way to access properties or metadata of a resource. With resources, you can use Resource#getValueMap() to obtain the value map of a resource. The various getter methods can be used to get the properties of the resource.

A ValueMap should be immutable.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
<T> T	get(String name, Class<T> type) Get a named property and convert it into the given type.
<T> T	get(String name, T defaultValue) Get a named property and convert it into the given type.

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

get

<T> T get(String name,
          Class<T> type)

Get a named property and convert it into the given type. This method does not support conversion into a primitive type or an array of a primitive type. It should return null in this case.

Type Parameters:

T - value type

Parameters:

name - The name of the property

type - The class of the type

Returns:

named value converted to type T or null if non existing or can't be converted

get

<T> T get(String name,
          T defaultValue)

Get a named property and convert it into the given type. This method does not support conversion into a primitive type or an array of a primitive type. It should return the default value in this case.

Type Parameters:

T - value type

Parameters:

name - The name of the property

defaultValue - The default value to use if the named property does not exist or cannot be converted to the requested type. The default value is also used to define the type to convert the value to. If this is null any existing property is not converted.

Returns:

named value converted to type T or the default value if non existing or can't be converted