MapOperations (Slider Core 0.90.2-incubating API)

java.lang.Object
- org.apache.slider.core.conf.MapOperations

All Implemented Interfaces:

Map<String,String>
```
public class MapOperations
extends Object
implements Map<String,String>
```
Standard map operations. This delegates the standard map interface to the map passed in, so it can be used to add more actions to the map.

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DAYS`
`static String`	`HOURS`
`static String`	`MINUTES`
`String`	`name`
`Map<String,String>`	`options` Global options
`static String`	`SECONDS`

Constructor Summary

Constructors
Constructor and Description
`MapOperations()`
`MapOperations(Map.Entry<String,Map<String,String>> entry)` Create an instance from an iterative map entry
`MapOperations(String name, Map<String,String> options)` Create an instance

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<String,String>>`	`entrySet()`
`boolean`	`equals(Object o)`
`String`	`get(Object key)`
`String`	`getMandatoryOption(String key)` Get a cluster option or value
`int`	`getMandatoryOptionInt(String option)` Get a mandatory integer option; use `Integer.decode(String)` so as to take hex oct and bin values too.
`String`	`getOption(String key, String defVal)` Get an option value
`Boolean`	`getOptionBool(String key, boolean defVal)` Get a boolean option
`int`	`getOptionInt(String option, int defVal)` Get an integer option; use `Integer.decode(String)` so as to take hex oct and bin values too.
`long`	`getOptionLong(String option, long defVal)` Get a long option; use `Long.decode(String)` so as to take hex oct and bin values too.
`long`	`getTimeRange(String basekey, int defDays, int defHours, int defMins, int defSecs)` Get the time range of a set of keys
`int`	`hashCode()`
`boolean`	`isEmpty()`
`boolean`	`isSet(String key)`
`Set<String>`	`keySet()`
`void`	`mergeMapPrefixedKeys(Map<String,String> that, String prefix, boolean overwrite)` Merge a map by prefixed keys
`void`	`mergeWithoutOverwrite(Map<String,String> that)`
`Map<String,String>`	`prefixedWith(String prefix)` Get all entries with a specific prefix
`String`	`put(String key, String value)`
`void`	`putAll(Map<? extends String,? extends String> m)`
`void`	`putIfUnset(String key, String value)` Set a property if it is not already set
`String`	`remove(Object key)`
`void`	`set(String key, Object value)`
`int`	`size()`
`String`	`toString()`
`Collection<String>`	`values()`
`void`	`verifyOptionSet(String key)` Verify that an option is set: that is defined AND non-empty

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

- Field Detail
  - DAYS
```
public static final String DAYS
```
    See Also:
    Constant Field Values
  - HOURS
```
public static final String HOURS
```
    See Also:
    Constant Field Values
  - MINUTES
```
public static final String MINUTES
```
    See Also:
    Constant Field Values
  - SECONDS
```
public static final String SECONDS
```
    See Also:
    Constant Field Values
  - options
```
public final Map<String,String> options
```
    Global options
  - name
```
public final String name
```
- Constructor Detail
  - MapOperations
```
public MapOperations()
```
  - MapOperations
```
public MapOperations(String name,
             Map<String,String> options)
```
    Create an instance
    
    Parameters:
    name - name
    options - source of options
  - MapOperations
```
public MapOperations(Map.Entry<String,Map<String,String>> entry)
```
    Create an instance from an iterative map entry
    
    Parameters:
    entry - entry to work with
- Method Detail
  - getOption
```
public String getOption(String key,
               String defVal)
```
    Get an option value
    
    Parameters:
    key - key
    defVal - default value
    
    Returns:
    option in map or the default
  - getOptionBool
```
public Boolean getOptionBool(String key,
                    boolean defVal)
```
    Get a boolean option
    
    Parameters:
    key - option key
    defVal - default value
    
    Returns:
    option true if the option equals "true", or the default value if the option was not defined at all.
  - getMandatoryOption
```
public String getMandatoryOption(String key)
                          throws BadConfigException
```
    Get a cluster option or value
    
    Parameters:
    key - option key
    
    Returns:
    the value
    
    Throws:
    
    BadConfigException - if the option is missing
  - getOptionInt
```
public int getOptionInt(String option,
               int defVal)
```
    Get an integer option; use Integer.decode(String) so as to take hex oct and bin values too.
    
    Parameters:
    option - option name
    defVal - default value
    
    Returns:
    parsed value
    
    Throws:
    
    NumberFormatException - if the role could not be parsed.
  - getOptionLong
```
public long getOptionLong(String option,
                 long defVal)
```
    Get a long option; use Long.decode(String) so as to take hex oct and bin values too.
    
    Parameters:
    option - option name
    defVal - default value
    
    Returns:
    parsed value
    
    Throws:
    
    NumberFormatException
  - getMandatoryOptionInt
```
public int getMandatoryOptionInt(String option)
                          throws BadConfigException
```
    Get a mandatory integer option; use Integer.decode(String) so as to take hex oct and bin values too.
    
    Parameters:
    option - option name
    
    Returns:
    parsed value
    
    Throws:
    
    NumberFormatException - if the option could not be parsed.
    
    BadConfigException - if the option could not be found
  - verifyOptionSet
```
public void verifyOptionSet(String key)
                     throws BadConfigException
```
    Verify that an option is set: that is defined AND non-empty
    
    Parameters:
    key -
    
    Throws:
    
    BadConfigException
  - mergeWithoutOverwrite
```
public void mergeWithoutOverwrite(Map<String,String> that)
```
  - mergeMapPrefixedKeys
```
public void mergeMapPrefixedKeys(Map<String,String> that,
                        String prefix,
                        boolean overwrite)
```
    Merge a map by prefixed keys
    
    Parameters:
    that - the map to merge in
    prefix - prefix to match on
    overwrite - flag to enable overwrite
  - putIfUnset
```
public void putIfUnset(String key,
              String value)
```
    Set a property if it is not already set
    
    Parameters:
    key - key
    value - value
  - set
```
public void set(String key,
       Object value)
```
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<String,String>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<String,String>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<String,String>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<String,String>
  - get
```
public String get(Object key)
```
    Specified by:
    
    get in interface Map<String,String>
  - put
```
public String put(String key,
         String value)
```
    Specified by:
    
    put in interface Map<String,String>
  - remove
```
public String remove(Object key)
```
    Specified by:
    
    remove in interface Map<String,String>
  - putAll
```
public void putAll(Map<? extends String,? extends String> m)
```
    Specified by:
    
    putAll in interface Map<String,String>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<String,String>
  - keySet
```
public Set<String> keySet()
```
    Specified by:
    
    keySet in interface Map<String,String>
  - values
```
public Collection<String> values()
```
    Specified by:
    
    values in interface Map<String,String>
  - entrySet
```
public Set<Map.Entry<String,String>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<String,String>
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Map<String,String>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<String,String>
    
    Overrides:
    
    hashCode in class Object
  - isSet
```
public boolean isSet(String key)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getTimeRange
```
public long getTimeRange(String basekey,
                int defDays,
                int defHours,
                int defMins,
                int defSecs)
```
    Get the time range of a set of keys
    
    Parameters:
    basekey - base key to which suffix gets applied
    defDays -
    defHours -
    defMins -
    defSecs -
    
    Returns:
    the aggregate time range in seconds
  - prefixedWith
```
public Map<String,String> prefixedWith(String prefix)
```
    Get all entries with a specific prefix
    
    Parameters:
    prefix - prefix
    
    Returns:
    a prefixed map, possibly empty

Class MapOperations

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DAYS

HOURS

MINUTES

SECONDS

options

name

Constructor Detail

MapOperations

MapOperations

MapOperations

Method Detail

getOption

getOptionBool

getMandatoryOption

getOptionInt

getOptionLong

getMandatoryOptionInt

verifyOptionSet

mergeWithoutOverwrite

mergeMapPrefixedKeys

putIfUnset

set

size

isEmpty

containsValue

containsKey

get

put

remove

putAll

clear

keySet

values

entrySet

equals

hashCode

isSet

toString

getTimeRange

prefixedWith