com.atakmap.android.ipc

Class DocumentedAction

java.lang.Object

com.atakmap.android.ipc.DocumentedAction

public class DocumentedAction
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 DocumentedAction 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	action
java.lang.String	description
DocumentedExtra[]	extras

Constructor Summary

Constructors

Constructor and Description
DocumentedAction(java.lang.String action, java.lang.String description) Basic action without any defined extras.
DocumentedAction(java.lang.String action, java.lang.String description, DocumentedExtra[] extras) Action with defined extras (either optional or required).

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

action

public final java.lang.String action

description

public final java.lang.String description

extras

public final DocumentedExtra[] extras

Constructor Detail

DocumentedAction

public DocumentedAction(java.lang.String action,
                        java.lang.String description)

Basic action without any defined extras.

Parameters:

action - the action.

description - the description of the action.

DocumentedAction

public DocumentedAction(java.lang.String action,
                        java.lang.String description,
                        DocumentedExtra[] extras)

Action with defined extras (either optional or required).

Parameters:

action - the action.

description - the description of the action.

extras - the list of extras,