com.atakmap.android.maps

Interface MetaDataHolder

All Known Implementing Classes:

AbstractSheet, AngleOverlayShape, Arrow, Association, AssociationSet, AutoSizeAngleOverlayShape, AxisOfAdvance, Circle, CircleCrumb, CompassRing, Crumb, CrumbTrail, DefaultMapGroup, DefaultMetaDataHolder, Doghouse, DrawingCircle, DrawingEllipse, DrawingRectangle, DrawingShape, DynamicRangeAndBearingEndpoint, EditablePolyline, Ellipse, FahArrowWidget.Item, FilterMetaDataHolder, FloatingPointRoute, ImageOverlay, MapData, MapGroup, MapItem, Marker, MetaMapPoint, MetaShape, MsdShape, MultiPolyline, PersistentCircleCrumbTrail, PointMapItem, Polyline, RangeAndBearingEndpoint, RangeAndBearingMapItem, RangeCircle, RangeRing, Rectangle, RootMapGroup, Route, Route.ControlPointMapItem, RouteTrackWrapper, RubberImage, RubberModel, RubberSheetMapGroup, SensorFOV, Shape, SimpleRectangle, TrackPolyline, VehicleModel, VehicleShape, Wedge

public interface MetaDataHolder

Method Summary

Modifier and Type	Method and Description
void	copyMetaData(java.util.Map<java.lang.String,java.lang.Object> bundle) Copies the metadata in the specified bundle into this metadata.
<T> T	get(java.lang.String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
boolean	getMetaBoolean(java.lang.String key, boolean defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
void	getMetaData(java.util.Map<java.lang.String,java.lang.Object> bundle) Returns a copy of the current metadata in the specified bundle.
double	getMetaDouble(java.lang.String key, double defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
int[]	getMetaIntArray(java.lang.String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
int	getMetaInteger(java.lang.String key, int defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
long	getMetaLong(java.lang.String key, long defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
java.util.Map<java.lang.String,java.lang.Object>	getMetaMap(java.lang.String key) Returns the bundle associated with the specified key.
<T extends android.os.Parcelable> T	getMetaParcelable(java.lang.String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
java.io.Serializable	getMetaSerializable(java.lang.String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
java.lang.String	getMetaString(java.lang.String key, java.lang.String defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key or if a null value is explicitly associated with the given key.
java.util.ArrayList<java.lang.String>	getMetaStringArrayList(java.lang.String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
boolean	hasMetaValue(java.lang.String key) Returns true if there is a metadata value associated with the specified key, false otherwise.
void	removeMetaData(java.lang.String key) Removes the metadata associated with the specified key.
void	setMetaBoolean(java.lang.String key, boolean value) Inserts a Boolean value into the mapping of this Bundle, replacing any existing value for the given key.
void	setMetaData(java.util.Map<java.lang.String,java.lang.Object> bundle) Sets this metadata to the metadata in the specified bundle.
void	setMetaDouble(java.lang.String key, double value) Inserts a double value into the mapping of this Bundle, replacing any existing value for the given key.
void	setMetaIntArray(java.lang.String key, int[] value) Inserts an int array value into the mapping of this Bundle, replacing any existing value for the given key.
void	setMetaInteger(java.lang.String key, int value) Inserts an int value into the mapping of this Bundle, replacing any existing value for the given key.
void	setMetaLong(java.lang.String key, long value) Inserts a long value into the mapping of this Bundle, replacing any existing value for the given key.
void	setMetaMap(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> bundle) Sets the bundle associated with the specified key.
void	setMetaParcelable(java.lang.String key, android.os.Parcelable value) Inserts a Parcelable value into the mapping of this Bundle, replacing any existing value for the given key.
void	setMetaSerializable(java.lang.String key, java.io.Serializable value) Inserts a Serializable value into the mapping of this Bundle, replacing any existing value for the given key.
void	setMetaString(java.lang.String key, java.lang.String value) Inserts a String value into the mapping of this Bundle, replacing any existing value for the given key.
void	setMetaStringArrayList(java.lang.String key, java.util.ArrayList<java.lang.String> value) Inserts an ArrayList value into the mapping of this Bundle, replacing any existing value for the given key.

Method Detail

getMetaString

java.lang.String getMetaString(java.lang.String key,
                               java.lang.String defaultValue)

Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key or if a null value is explicitly associated with the given key.

Parameters:

key - a String, or null

defaultValue - Value to return if key does not exist or if a null value is associated with the given key.

Returns:

the String value associated with the given key, or defaultValue if no valid String object is currently mapped to that key.

setMetaString

void setMetaString(java.lang.String key,
                   java.lang.String value)

Inserts a String value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.

Parameters:

key - a String, or null

value - a String, or null

getMetaInteger

int getMetaInteger(java.lang.String key,
                   int defaultValue)

Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.

Parameters:

key - a String

defaultValue - Value to return if key does not exist

Returns:

an int value

setMetaInteger

void setMetaInteger(java.lang.String key,
                    int value)

Inserts an int value into the mapping of this Bundle, replacing any existing value for the given key.

Parameters:

key - a String, or null

value - an int

getMetaDouble

double getMetaDouble(java.lang.String key,
                     double defaultValue)

Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.

Parameters:

key - a String

defaultValue - Value to return if key does not exist

Returns:

a double value

setMetaDouble

void setMetaDouble(java.lang.String key,
                   double value)

Inserts a double value into the mapping of this Bundle, replacing any existing value for the given key.

Parameters:

key - a String, or null

value - a double

getMetaLong

long getMetaLong(java.lang.String key,
                 long defaultValue)

Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.

Parameters:

key - a String

defaultValue - Value to return if key does not exist

Returns:

a long value

setMetaLong

void setMetaLong(java.lang.String key,
                 long value)

Inserts a long value into the mapping of this Bundle, replacing any existing value for the given key.

Parameters:

key - a String, or null

value - a long

getMetaBoolean

boolean getMetaBoolean(java.lang.String key,
                       boolean defaultValue)

Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.

Parameters:

key - a String

defaultValue - Value to return if key does not exist

Returns:

a boolean value

setMetaBoolean

void setMetaBoolean(java.lang.String key,
                    boolean value)

Inserts a Boolean value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.

Parameters:

key - a String, or null

value - a boolean

getMetaStringArrayList

java.util.ArrayList<java.lang.String> getMetaStringArrayList(java.lang.String key)

Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.

Parameters:

key - a String, or null

Returns:

an ArrayList value, or null

setMetaStringArrayList

void setMetaStringArrayList(java.lang.String key,
                            java.util.ArrayList<java.lang.String> value)

Inserts an ArrayList value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.

Parameters:

key - a String, or null

value - an ArrayList object, or null

getMetaIntArray

int[] getMetaIntArray(java.lang.String key)

Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.

Parameters:

key - a String, or null

Returns:

an int[] value, or null

setMetaIntArray

void setMetaIntArray(java.lang.String key,
                     int[] value)

Inserts an int array value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.

Parameters:

key - a String, or null

value - an int array object, or null

getMetaSerializable

java.io.Serializable getMetaSerializable(java.lang.String key)

Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.

Parameters:

key - a String, or null

Returns:

a Serializable value, or null

setMetaSerializable

void setMetaSerializable(java.lang.String key,
                         java.io.Serializable value)

Inserts a Serializable value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.

Parameters:

key - a String, or null

value - a Serializable object, or null

getMetaParcelable

<T extends android.os.Parcelable> T getMetaParcelable(java.lang.String key)

Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.

Parameters:

key - a String, or null

Returns:

a Parcelable value, or null

setMetaParcelable

void setMetaParcelable(java.lang.String key,
                       android.os.Parcelable value)

Inserts a Parcelable value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.

Parameters:

key - a String, or null

value - a Parcelable object, or null

get

<T> T get(java.lang.String key)

Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.

Parameters:

key - a String, or null

Returns:

a value, or null

getMetaMap

java.util.Map<java.lang.String,java.lang.Object> getMetaMap(java.lang.String key)

Returns the bundle associated with the specified key. The returned bundle is a copy and changes made to it will not be reflected in the underlying metadata.

Parameters:

key -

Returns:

setMetaMap

void setMetaMap(java.lang.String key,
                java.util.Map<java.lang.String,java.lang.Object> bundle)

Sets the bundle associated with the specified key. The stored bundle is a copy of the provided bundle; changes made to bundle after the method returns will not be reflected in the underlying metadata.

Parameters:

key -

bundle -

hasMetaValue

boolean hasMetaValue(java.lang.String key)

Returns true if there is a metadata value associated with the specified key, false otherwise.

Parameters:

key -

Returns:

setMetaData

void setMetaData(java.util.Map<java.lang.String,java.lang.Object> bundle)

Sets this metadata to the metadata in the specified bundle.

Parameters:

bundle -

copyMetaData

void copyMetaData(java.util.Map<java.lang.String,java.lang.Object> bundle)

Copies the metadata in the specified bundle into this metadata.

Parameters:

bundle -

getMetaData

void getMetaData(java.util.Map<java.lang.String,java.lang.Object> bundle)

Returns a copy of the current metadata in the specified bundle.

Parameters:

bundle -

removeMetaData

void removeMetaData(java.lang.String key)

Removes the metadata associated with the specified key.

Parameters:

key -