com.atakmap.android.ipc

Class DocumentedExtra

java.lang.Object

com.atakmap.android.ipc.DocumentedExtra

public class DocumentedExtra
extends java.lang.Object

Instead of using IntentFilters, ATAK makes use of DocumentedIntentFilter to provide for automatic extraction of documentation supplied by the developer. As part of the DocumentedIntent filter, the is DocumentedExtra that can be supplied in order to produce more robust documentation as well as in the future allow for validation of intents being passed into broadcast.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	description
java.lang.String	name
boolean	optional
java.lang.Class<?>	type

Constructor Summary

Constructors

Constructor and Description
DocumentedExtra(java.lang.String name, java.lang.String description) A documented extra that is associated with the action that is required to exist.
DocumentedExtra(java.lang.String name, java.lang.String description, boolean optional) /** A documented extra that is associated with the action.
DocumentedExtra(java.lang.String name, java.lang.String description, boolean optional, java.lang.Class<?> type) A documented extra that is associated with the action.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

public final java.lang.String name

description

public final java.lang.String description

optional

public final boolean optional

type

public final java.lang.Class<?> type

Constructor Detail

DocumentedExtra

public DocumentedExtra(java.lang.String name,
                       java.lang.String description)

A documented extra that is associated with the action that is required to exist.

Parameters:

name - the name of the extra

description - the description of the extra

DocumentedExtra

public DocumentedExtra(java.lang.String name,
                       java.lang.String description,
                       boolean optional)

/** A documented extra that is associated with the action.

Parameters:

name - the name of the extra

description - the description of the extra

optional - if the extra is optional when the action is performed.

DocumentedExtra

public DocumentedExtra(java.lang.String name,
                       java.lang.String description,
                       boolean optional,
                       java.lang.Class<?> type)

A documented extra that is associated with the action.

Parameters:

name - the name of the extra

description - the description of the extra

optional - if the extra is optional when the action is performed.

type - the class that needs to be placed into the extra.