Index (pathfinder-android 0.0.16 API)

A C D E F G H I L M N O P R S T U V W X

A

Action - Class in xyz.thepathfinder.android: Actions represent transport and commodity actions, such as picking up a commodity, dropping off a commodity, or a transport start location.
Action(JsonObject, PathfinderServices) - Constructor for class xyz.thepathfinder.android.Action: Constructs an Action with a JSON object that represents an Action.
actions - Variable in class xyz.thepathfinder.android.Route: Actions for the transport to perform
ActionStatus - Enum in xyz.thepathfinder.android: An enum for the possible statuses of an Action.
ActionStatus(String) - Constructor for enum xyz.thepathfinder.android.ActionStatus: A constructor to make each possible status.
addAuthenticationListener(AuthenticationListener) - Method in class xyz.thepathfinder.android.Pathfinder: Adds an AuthenticationListener to listen for the success or failure of the authentication sequence.
addCommodity(Commodity) - Method in class xyz.thepathfinder.android.Cluster: Adds a commodity to this cluster's list of available commodities.
addCreateBacklog(Model) - Method in class xyz.thepathfinder.android.ModelRegistry: Adds a Model to the create backlog.
addListener(E) - Method in class xyz.thepathfinder.android.Listenable: Adds a listener to the object.
addTransport(Transport) - Method in class xyz.thepathfinder.android.Cluster: Adds a transport to this cluster's list of available transports.
applicationIdentifier - Variable in class xyz.thepathfinder.android.Authenticator: Application Identifier for the application accessing the pathfinder server.
applicationIdentifier - Variable in class xyz.thepathfinder.android.Pathfinder: Application Identifier that identifies the application on the pathfinder server.
authenticationFailed(String) - Method in class xyz.thepathfinder.android.AuthenticationListener: Invoked when the authentication sequence fails.
authenticationFailed(String) - Method in class xyz.thepathfinder.android.Authenticator: Tells the listeners that the authentication sequence failed.
AuthenticationListener - Class in xyz.thepathfinder.android: The AuthenticationListener interface gives developers access to notifications when the user authentication status is known.
AuthenticationListener() - Constructor for class xyz.thepathfinder.android.AuthenticationListener
AuthenticationMessageHandler - Class in xyz.thepathfinder.android: Routes all web socket messages received during the authentication sequence to the Authenticator.
AuthenticationMessageHandler(Authenticator) - Constructor for class xyz.thepathfinder.android.AuthenticationMessageHandler: Routes all web socket messages received during the authentication sequence to the Authenticator.
authenticationServerURL - Variable in class xyz.thepathfinder.android.Authenticator: URL of the server that is responsible for authenticating the users.
authenticationSuccessful() - Method in class xyz.thepathfinder.android.AuthenticationListener: Invoked when the user is successfully authenticated.
authenticator - Variable in class xyz.thepathfinder.android.AuthenticationMessageHandler: Authenticator that receives all of the messages.
Authenticator - Class in xyz.thepathfinder.android: Handles all of the initial authentication sequence.
Authenticator(String, String, String, PathfinderServices) - Constructor for class xyz.thepathfinder.android.Authenticator: Creates an authenticator responsible for authenticating the user.
authenticator - Variable in class xyz.thepathfinder.android.Pathfinder: The authenticator controlling the authentication sequence.

C

checkClusterFields(JsonObject) - Static method in class xyz.thepathfinder.android.Cluster: Checks the json object for all the required fields of a cluster object.
checkCommodityField(JsonObject, String) - Static method in class xyz.thepathfinder.android.Commodity: Checks a JSON object for a specific field.
checkCommodityFields(JsonObject) - Static method in class xyz.thepathfinder.android.Commodity: Checks if a JSON object can be parsed to a commodity.
checkTransportField(JsonObject, String) - Static method in class xyz.thepathfinder.android.Transport: Checks for a field in the JSON.
checkTransportFields(JsonObject) - Static method in class xyz.thepathfinder.android.Transport: Checks if the JSON can be parsed to a transport.
close(CloseReason) - Method in class xyz.thepathfinder.android.Connection: Closes the web socket connection with the Pathfinder server.
close() - Method in class xyz.thepathfinder.android.Pathfinder: Closes the web socket connection to the Pathfinder server with a normal close condition.
close(CloseReason) - Method in class xyz.thepathfinder.android.Pathfinder: Closes the web socket connection to the Pathfinder server, if it is still open, with the specified reason.
Cluster - Class in xyz.thepathfinder.android: A cluster represents a set of commodities, sub-clusters, and transports.
Cluster(String, PathfinderServices) - Constructor for class xyz.thepathfinder.android.Cluster: Constructor for a cluster object.
ClusterListener - Class in xyz.thepathfinder.android: The ClusterListener interface gives developers access to notifications when a cluster is modified.
ClusterListener() - Constructor for class xyz.thepathfinder.android.ClusterListener
commodities - Variable in class xyz.thepathfinder.android.Cluster: Maps a path in the form of a string to the commodities directly under this cluster
commodities - Variable in class xyz.thepathfinder.android.Transport: List of commodities being carried by the transport.
commoditiesUpdated(Collection<Commodity>) - Method in class xyz.thepathfinder.android.ClusterListener: Invoked when at least one commodity was updated by a message.
commoditiesUpdated(List<Commodity>) - Method in class xyz.thepathfinder.android.TransportListener: Invoked when the transport's commodities was updated by a message.
commodity - Variable in class xyz.thepathfinder.android.Action: The commodity associated with the action.
Commodity - Class in xyz.thepathfinder.android: Interface to the Pathfinder server's commodity API.
Commodity(String, PathfinderServices) - Constructor for class xyz.thepathfinder.android.Commodity: Constructs a commodity object with the path specified.
Commodity(String, double, double, double, double, CommodityStatus, JsonObject, Long, PathfinderServices) - Constructor for class xyz.thepathfinder.android.Commodity: Constructs a commodity object with the specified parameters.
commodityAdded(Commodity) - Method in class xyz.thepathfinder.android.ClusterListener: Invoked when a commodity was added to the cluster by a message.
CommodityListener - Class in xyz.thepathfinder.android: The CommodityListener interface gives developers access to notifications when a commodity is modified.
CommodityListener() - Constructor for class xyz.thepathfinder.android.CommodityListener
commodityRemoved(Commodity) - Method in class xyz.thepathfinder.android.ClusterListener: Invoked when a commodity was removed from the cluster by a message.
CommodityStatus - Enum in xyz.thepathfinder.android: An enum for the possible statuses of a Commodity.
CommodityStatus(String) - Constructor for enum xyz.thepathfinder.android.CommodityStatus: A constructor to make each possible status.
commodityUpdated(Commodity) - Method in class xyz.thepathfinder.android.ClusterListener: Invoked when a commodity in this cluster was updated by a message.
connect() - Method in class xyz.thepathfinder.android.Pathfinder: Establishes a connection to the Pathfinder server, if the connection is not already open.
connect(boolean) - Method in class xyz.thepathfinder.android.Pathfinder: Establishes a connection to the Pathfinder server, if the connection is not already open.
connect() - Method in class xyz.thepathfinder.android.SubscribableCrudModel: Reads the model specified by the path from the server.
connected(T) - Method in class xyz.thepathfinder.android.ModelListener: Invoked when the model receives a connected message.
Connection - Class in xyz.thepathfinder.android: Controls access the web socket connection with the Pathfinder sever.
Connection() - Constructor for class xyz.thepathfinder.android.Connection: Constructs a connection object that controls access to the web socket connection with the Pathfinder Server.
connection - Variable in class xyz.thepathfinder.android.PathfinderServices: Connection to the pathfinder server
constructPathfinderServices(String, String, String) - Method in class xyz.thepathfinder.android.Pathfinder: Sets the PathfinderServices object.
create() - Method in class xyz.thepathfinder.android.SubscribableCrudModel: Creates the model at the path specified on the server.
createBacklog - Variable in class xyz.thepathfinder.android.ModelRegistry: List of models that have unknown paths, occurs on create with commodities and transports.
createCluster - Variable in class xyz.thepathfinder.android.Commodity: The cluster to be created under.
createCluster - Variable in class xyz.thepathfinder.android.Transport: The cluster to be created under.
createCommodity(double, double, double, double, CommodityStatus, JsonObject) - Method in class xyz.thepathfinder.android.Cluster: Creates a commodity under this cluster on the pathfinder server.
createCommodity(JsonObject) - Method in class xyz.thepathfinder.android.Cluster: Creates a commodity with a values specified in the JSON object.
created(T) - Method in class xyz.thepathfinder.android.ModelListener: Invoked when the model receives a created message.
createSubcluster(String) - Method in class xyz.thepathfinder.android.Cluster: Creates a subcluster under this cluster on the pathfinder server.
createTransport(double, double, TransportStatus, JsonObject) - Method in class xyz.thepathfinder.android.Cluster: Creates a transport under this cluster on the pathfinder server.
createValueJson() - Method in class xyz.thepathfinder.android.Cluster: Returns the value used in create request to the Pathfinder server
createValueJson() - Method in class xyz.thepathfinder.android.Commodity: Returns the value used in create request to the Pathfinder server
createValueJson() - Method in class xyz.thepathfinder.android.SubscribableCrudModel: Returns the JSON needed to create the object on the Pathfinder server.
createValueJson() - Method in class xyz.thepathfinder.android.Transport: Returns the value used in create request to the Pathfinder server

D

DEFAULT_AUTH_URI - Static variable in class xyz.thepathfinder.android.Pathfinder: The default authentication server URI.
DEFAULT_PATH - Static variable in class xyz.thepathfinder.android.Path: Default cluster path.
DEFAULT_WEBSOCKET_URI - Static variable in class xyz.thepathfinder.android.Pathfinder: The default web socket URI.
delete() - Method in class xyz.thepathfinder.android.SubscribableCrudModel: Deletes the model specified by the path on the server.
deleted(T) - Method in class xyz.thepathfinder.android.ModelListener: Invoked when the model receives a deleted message.

E

endLatitude - Variable in class xyz.thepathfinder.android.Commodity: The drop off latitude of the commodity.
endLocationUpdated(double, double) - Method in class xyz.thepathfinder.android.CommodityListener: Invoked when the commodity's end location was updated by a message.
endLongitude - Variable in class xyz.thepathfinder.android.Commodity: The drop off longitude of the commodity.
equals(String) - Method in enum xyz.thepathfinder.android.ActionStatus: Checks if this status is the same as the provided status.
equals(String) - Method in enum xyz.thepathfinder.android.CommodityStatus: Checks if this status is the same as the provided status.
equals(String) - Method in enum xyz.thepathfinder.android.ModelType: Checks if this type is the same as the provided type.
equals(Object) - Method in class xyz.thepathfinder.android.Path
equals(String) - Method in enum xyz.thepathfinder.android.TransportStatus: Checks if this status is the same as the provided status.
error(String) - Method in class xyz.thepathfinder.android.ModelListener: Invoked when the model receives a error message.

F

findInCreateBacklog(JsonObject, ModelType) - Method in class xyz.thepathfinder.android.ModelRegistry: Finds a model in the create backlog.

G

getActions(JsonObject, PathfinderServices) - Static method in class xyz.thepathfinder.android.Route: Gets the actions for the transport to perform from the route JSON.
getActions() - Method in class xyz.thepathfinder.android.Route: Returns a list of actions for the transport to perform.
getChildPath(String, ModelType) - Method in class xyz.thepathfinder.android.Model: Returns the path of a child of this model.
getChildPath(String, ModelType) - Method in class xyz.thepathfinder.android.Path: Returns the child path of this path plus the name provided.
getCluster(String) - Method in class xyz.thepathfinder.android.Pathfinder: Gets an unconnected cluster pointing to the path specified.
getCommodities() - Method in class xyz.thepathfinder.android.Cluster: Returns an immutable collection of this cluster's commodities.
getCommodities() - Method in class xyz.thepathfinder.android.Transport: Returns an unmodifiable list of the commodities being carried by this transport.
getCommoditiesMap() - Method in class xyz.thepathfinder.android.Cluster: Returns an immutable map of this cluster's commodities.
getCommodity(JsonObject, PathfinderServices) - Static method in class xyz.thepathfinder.android.Action: Returns the commodity of an action in the form a JSON object.
getCommodity() - Method in class xyz.thepathfinder.android.Action: Returns the commodity associated with this action.
getCommodity(String) - Method in class xyz.thepathfinder.android.Cluster: Returns a commodity directly under this cluster by its path.
getCommodity(String) - Method in class xyz.thepathfinder.android.Pathfinder: Gets an unconnected commodity pointing to the path specified.
getConnection() - Method in class xyz.thepathfinder.android.PathfinderServices: Returns the connection to the pathfinder server.
getDefaultCluster() - Method in class xyz.thepathfinder.android.Pathfinder: Gets an unconnected cluster pointing to the default cluster for the application identifier provided.
getEndLatitude() - Method in class xyz.thepathfinder.android.Commodity: Returns the current end latitude of the commodity.
getEndLongitude() - Method in class xyz.thepathfinder.android.Commodity: Returns the current end longitude of the commodity.
getInstance(String, PathfinderServices) - Static method in class xyz.thepathfinder.android.Cluster: Returns an instance of cluster object based on the path parameter.
getInstance(JsonObject, PathfinderServices) - Static method in class xyz.thepathfinder.android.Cluster: Returns an instance of cluster object based on the path in clusterJson.
getInstance(String, PathfinderServices) - Static method in class xyz.thepathfinder.android.Commodity: Returns a commodity that has been registered with the ModelRegistry or a new commodity if one hasn't been created with that path.
getInstance(JsonObject, PathfinderServices) - Static method in class xyz.thepathfinder.android.Commodity: Returns a commodity that has been registered with the ModelRegistry or a new commodity if one hasn't been created with that path.
getInstance(String, PathfinderServices) - Static method in class xyz.thepathfinder.android.Transport: Returns an instance of a transport model.
getInstance(JsonObject, PathfinderServices) - Static method in class xyz.thepathfinder.android.Transport: Returns an instance of a transport model.
getLatitude(JsonObject) - Static method in class xyz.thepathfinder.android.Action: Returns the latitude of an action in the form a JSON object.
getLatitude() - Method in class xyz.thepathfinder.android.Action: The latitude that the action occurs at.
getLatitude() - Method in class xyz.thepathfinder.android.Transport: Returns the latitude of this transport.
getListeners() - Method in class xyz.thepathfinder.android.Listenable: Returns a list of all the current listeners.
getLongitude(JsonObject) - Static method in class xyz.thepathfinder.android.Action: Returns the longitude of an action in the form a JSON object.
getLongitude() - Method in class xyz.thepathfinder.android.Action: The longitude that the action occurs at.
getLongitude() - Method in class xyz.thepathfinder.android.Transport: Returns the longitude of this transport.
getMessageHeader(String) - Method in class xyz.thepathfinder.android.SubscribableModel: Returns the header of the message to send to the pathfinder server.
getMetadata() - Method in class xyz.thepathfinder.android.Commodity: Returns the metadata of the commodity in the form of a Json Object.
getMetadata() - Method in class xyz.thepathfinder.android.Transport: Returns the metadata of this transport.
getModel(Path) - Method in class xyz.thepathfinder.android.ModelRegistry: Returns the Model associated with the specified path in the registry.
getModelType() - Method in class xyz.thepathfinder.android.Model: Returns the type of the model
getModelType(String) - Static method in enum xyz.thepathfinder.android.ModelType: Returns the enum version of a model type from a string.
getModelType() - Method in class xyz.thepathfinder.android.Path: Returns the type of the model.
getName() - Method in class xyz.thepathfinder.android.Model: Returns the name of the model.
getName() - Method in class xyz.thepathfinder.android.Path: Returns the name of the model.
getParentCluster() - Method in class xyz.thepathfinder.android.Model: Returns the parent cluster of this model.
getParentPath() - Method in class xyz.thepathfinder.android.Model: Returns the path of the parent of this model.
getParentPath() - Method in class xyz.thepathfinder.android.Path: Returns the parent's path of this path.
getPath(JsonObject) - Static method in class xyz.thepathfinder.android.Cluster: Returns the path as a string from a JSON object formatted as cluster.
getPath(JsonObject) - Static method in class xyz.thepathfinder.android.Commodity: Returns the path for a JSON object that represents a commodity.
getPath() - Method in class xyz.thepathfinder.android.Model: Returns the path of the model.
getPath(JsonObject) - Method in class xyz.thepathfinder.android.ModelMessageHandler: Returns the path of a received message.
getPath(JsonObject) - Static method in class xyz.thepathfinder.android.Transport: Returns the path of the transport from JSON that represents a transport.
getPathName() - Method in class xyz.thepathfinder.android.Model: Returns the string of the path of the model.
getPathName() - Method in class xyz.thepathfinder.android.Path: Returns the path of the model.
getReceivedMessageCount() - Method in class xyz.thepathfinder.android.AuthenticationMessageHandler: Returns the number of messages received by the message handler.
getReceivedMessageCount() - Method in class xyz.thepathfinder.android.Connection: Returns the number of messages receive through the web socket.
getReceivedMessageCount() - Method in interface xyz.thepathfinder.android.MessageHandler: Returns the number of messages received by the message handler.
getReceivedMessageCount() - Method in class xyz.thepathfinder.android.ModelMessageHandler: Returns the number of message received by the web socket.
getReceivedMessageCount() - Method in class xyz.thepathfinder.android.Pathfinder: Returns the number of web socket messages received from the Pathfinder server.
getRegistry() - Method in class xyz.thepathfinder.android.PathfinderServices: Returns the model registry.
getRoute() - Method in class xyz.thepathfinder.android.Commodity: Returns the route for this commodity.
getRoute() - Method in class xyz.thepathfinder.android.Transport: Returns the route of this transport.
getRoutes() - Method in class xyz.thepathfinder.android.Cluster: Returns an immutable collection of this cluster's routes.
getSentMessageCount() - Method in class xyz.thepathfinder.android.Connection: Returns the number of messages sent through the web socket.
getSentMessageCount() - Method in class xyz.thepathfinder.android.Pathfinder: Returns the number of web socket messages sent to the Pathfinder server.
getServices() - Method in class xyz.thepathfinder.android.Model: Returns the pathfinder services object.
getStartLatitude() - Method in class xyz.thepathfinder.android.Commodity: Returns the current start latitude of the commodity.
getStartLongitude() - Method in class xyz.thepathfinder.android.Commodity: Returns the current start longitude of the commodity.
getStatus(JsonObject) - Static method in class xyz.thepathfinder.android.Action: Returns the status of an action in the form a JSON object.
getStatus(String) - Static method in class xyz.thepathfinder.android.Action: Returns the status of an action in the form of a string.
getStatus() - Method in class xyz.thepathfinder.android.Action: Returns the status of the action.
getStatus(String) - Static method in enum xyz.thepathfinder.android.ActionStatus: Changes a String to an ActionStatus.
getStatus(String) - Static method in class xyz.thepathfinder.android.Commodity: Returns the enum version of a status from a string.
getStatus() - Method in class xyz.thepathfinder.android.Commodity: Returns the current status of the commodity.
getStatus(String) - Static method in enum xyz.thepathfinder.android.CommodityStatus: Changes a String to an CommodityStatus.
getStatus(String) - Static method in class xyz.thepathfinder.android.Transport: Converts a string to a TransportStatus if possible, null otherwise.
getStatus() - Method in class xyz.thepathfinder.android.Transport: Returns the status of this transport.
getStatus(String) - Static method in enum xyz.thepathfinder.android.TransportStatus: Changes a String to an TransportStatus.
getSubcluster(String) - Method in class xyz.thepathfinder.android.Cluster: Returns a direct descendant subcluster by its path.
getSubclusters() - Method in class xyz.thepathfinder.android.Cluster: Returns an immutable collection of this cluster's direct subclusters.
getSubclustersMap() - Method in class xyz.thepathfinder.android.Cluster: Returns an immutable map of this cluster's direct subclusters.
getSubmodelPath(JsonObject) - Method in class xyz.thepathfinder.android.Cluster: Returns the path name of a JSON Model.
getThis() - Method in class xyz.thepathfinder.android.Cluster: Returns the current object represented by this.
getThis() - Method in class xyz.thepathfinder.android.Commodity: Returns the current object represented by this.
getThis() - Method in class xyz.thepathfinder.android.Model: Returns the current object represented by this.
getThis() - Method in class xyz.thepathfinder.android.Transport: Returns the current object represented by this.
getTransport(String) - Method in class xyz.thepathfinder.android.Cluster: Returns a transport directly under this cluster by its path.
getTransport() - Method in class xyz.thepathfinder.android.Commodity: Returns the transport carrying the commodity.
getTransport(String) - Method in class xyz.thepathfinder.android.Pathfinder: Gets an unconnected transport pointing to the path specified.
getTransport(JsonObject, PathfinderServices) - Static method in class xyz.thepathfinder.android.Route: Gets the transport from the route JSON.
getTransport() - Method in class xyz.thepathfinder.android.Route: Returns the transport to perform the route.
getTransportId() - Method in class xyz.thepathfinder.android.Commodity: Returns the transport id carrying the commodity.
getTransports() - Method in class xyz.thepathfinder.android.Cluster: Returns an immutable collection of this cluster's transports.
getTransportsMap() - Method in class xyz.thepathfinder.android.Cluster: Returns an immutable map of this cluster's transports.

H

hashCode() - Method in class xyz.thepathfinder.android.Path

I

initCommodity(double, double, double, double, CommodityStatus, JsonObject, String) - Method in class xyz.thepathfinder.android.Commodity: Initializes a commodity object with the specified parameters.
initTransport(double, double, TransportStatus, JsonObject, String) - Method in class xyz.thepathfinder.android.Transport: Initializes a transport object with the specified parameters.
isConnected() - Method in class xyz.thepathfinder.android.Connection: Returns if the web socket is connected.
isConnected - Variable in class xyz.thepathfinder.android.Model: Whether or not the model has connected with the Pathfinder server.
isConnected() - Method in class xyz.thepathfinder.android.Model: Returns if the model has connected to the Pathfinder server.
isConnected() - Method in class xyz.thepathfinder.android.Pathfinder: Returns true if the web socket connection to the Pathfinder server is open.
isModelRegistered(Path) - Method in class xyz.thepathfinder.android.ModelRegistry: Returns if a Model has been registered with the specified path.
isPathUnknown() - Method in class xyz.thepathfinder.android.Model: Returns true if the model's path is unknown.
isValidName(String) - Static method in class xyz.thepathfinder.android.Path: Returns if the provided name is a valid name.
isValidPath(String) - Static method in class xyz.thepathfinder.android.Path: Returns if the provided path's characters are valid on the Pathfinder server.

L

latitude - Variable in class xyz.thepathfinder.android.Action: The latitude the action occurs at.
latitude - Variable in class xyz.thepathfinder.android.Transport: Latitude of the transport.
Listenable<E extends Listener,T> - Class in xyz.thepathfinder.android: Allows objects to listen for notifications.
Listenable() - Constructor for class xyz.thepathfinder.android.Listenable: Creates a listenable object.
Listener - Interface in xyz.thepathfinder.android: Interface for listeners to implement.
listeners - Variable in class xyz.thepathfinder.android.Listenable: The list of listeners
locationUpdated(double, double) - Method in class xyz.thepathfinder.android.TransportListener: Invoked when the transport's location was updated by a message.
logger - Static variable in class xyz.thepathfinder.android.Action: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.AuthenticationMessageHandler: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.Authenticator: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.Cluster: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.Commodity: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.Connection: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.Model: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.ModelMessageHandler: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.ModelRegistry: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.Path: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.Pathfinder: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.Route: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.SubscribableCrudModel: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.SubscribableModel: Logs actions performed by the class.
logger - Static variable in class xyz.thepathfinder.android.Transport: Logs actions performed by the class.
longitude - Variable in class xyz.thepathfinder.android.Action: The longitude the action occurs at.
longitude - Variable in class xyz.thepathfinder.android.Transport: Longitude of the transport.

M

messageBacklog - Variable in class xyz.thepathfinder.android.Model: Messages saved to be sent later, after the model's path is fully defined.
messageHandler - Variable in class xyz.thepathfinder.android.Connection: Handles incoming web socket messages.
MessageHandler - Interface in xyz.thepathfinder.android: Routes all web socket messages received to the receiving models.
messageQueue - Variable in class xyz.thepathfinder.android.Connection: Stores messages while the connection is down.
metadata - Variable in class xyz.thepathfinder.android.Commodity: The metadata of this commodity.
metadata - Variable in class xyz.thepathfinder.android.Transport: Metadata of the transport.
metadataUpdated(JsonObject) - Method in class xyz.thepathfinder.android.CommodityListener: Invoked when the commodity's metadata was updated by a message.
metadataUpdated(JsonObject) - Method in class xyz.thepathfinder.android.TransportListener: Invoked when the transport's metadata was updated by a message.
Model<T extends Model<T,E>,E extends ModelListener<T>> - Class in xyz.thepathfinder.android: Basic class for dealing with models from the Pathfinder server.
Model(String, ModelType, PathfinderServices) - Constructor for class xyz.thepathfinder.android.Model: Creates a basic object that all pathfinder models should use.
ModelListener<T extends Model> - Class in xyz.thepathfinder.android: An interface for Listener classes to implement.
ModelListener() - Constructor for class xyz.thepathfinder.android.ModelListener
ModelMessageHandler - Class in xyz.thepathfinder.android: Routes all web socket messages received to the receiving models.
ModelMessageHandler(PathfinderServices) - Constructor for class xyz.thepathfinder.android.ModelMessageHandler: Constructs the message handler.
ModelRegistry - Class in xyz.thepathfinder.android: The ModelRegistry keeps track of all Models created by the Pathfinder SDK.
ModelRegistry() - Constructor for class xyz.thepathfinder.android.ModelRegistry: Constructs a ModelRegistry object with an empty registry of Models.
models - Variable in class xyz.thepathfinder.android.ModelRegistry: Map to all the Models created by the SDK.
ModelType - Enum in xyz.thepathfinder.android: An enum for the possible types of Models.
ModelType(String) - Constructor for enum xyz.thepathfinder.android.ModelType: A constructor to make each possible type.
modelType - Variable in class xyz.thepathfinder.android.Path: Type of the model.

N

notifyUpdate(String, JsonObject) - Method in class xyz.thepathfinder.android.Authenticator: Method called when an update occurs.
notifyUpdate(String, T) - Method in class xyz.thepathfinder.android.Listenable: Method called when an update occurs.
notifyUpdate(String, JsonObject) - Method in class xyz.thepathfinder.android.Model: Method called when an update occurs.

O

onClose(Session, CloseReason) - Method in class xyz.thepathfinder.android.Connection
onError(Session, Throwable) - Method in class xyz.thepathfinder.android.Connection
onMessage(String) - Method in class xyz.thepathfinder.android.AuthenticationMessageHandler
onMessage(String) - Method in class xyz.thepathfinder.android.ModelMessageHandler: Invoked when the web socket receives a message.
onOpen(Session, EndpointConfig) - Method in class xyz.thepathfinder.android.Connection

P

path - Variable in class xyz.thepathfinder.android.Model: The path of the model.
Path - Class in xyz.thepathfinder.android: Class is used to ease the manipulation of paths to models on the Pathfinder server.
Path(String, ModelType) - Constructor for class xyz.thepathfinder.android.Path: Constructs a path to a model.
path - Variable in class xyz.thepathfinder.android.Path: A string representing the path.
PATH_SEPARATOR - Static variable in class xyz.thepathfinder.android.Path: Separator for path names.
Pathfinder - Class in xyz.thepathfinder.android: The Pathfinder class is the main entry point to the Pathfinder API.
Pathfinder(String, String) - Constructor for class xyz.thepathfinder.android.Pathfinder: Constructs a Pathfinder object.
Pathfinder(String, String, String) - Constructor for class xyz.thepathfinder.android.Pathfinder: Constructs a Pathfinder object.
Pathfinder(String, String, URI) - Constructor for class xyz.thepathfinder.android.Pathfinder: Constructs a Pathfinder object.
PathfinderServices - Class in xyz.thepathfinder.android: Gives access to the model repository and the connection to the pathfinder server.
PathfinderServices(ModelRegistry, Connection) - Constructor for class xyz.thepathfinder.android.PathfinderServices: Constructs a pathfinder services object.

R

receivedMessageCount - Variable in class xyz.thepathfinder.android.AuthenticationMessageHandler: Number of messages received by this message handler.
receivedMessageCount - Variable in class xyz.thepathfinder.android.ModelMessageHandler: Number of messages received, helps with testing.
registerModel(Model) - Method in class xyz.thepathfinder.android.ModelRegistry: Adds a Model to the registry.
registry - Variable in class xyz.thepathfinder.android.PathfinderServices: Holds access to all the models
removeAuthenticationListener(AuthenticationListener) - Method in class xyz.thepathfinder.android.Pathfinder: Removes an AuthenticationListener.
removeCreateBacklog(Model) - Method in class xyz.thepathfinder.android.ModelRegistry: Removes a Model from the create backlog.
removeListener(E) - Method in class xyz.thepathfinder.android.Listenable: Removes a listener from the object.
route(JsonObject, PathfinderServices) - Method in class xyz.thepathfinder.android.Cluster: Updates the models routes.
route - Variable in class xyz.thepathfinder.android.Commodity: The route of this commodity.
route(JsonObject, PathfinderServices) - Method in class xyz.thepathfinder.android.Commodity: Updates the models routes.
route(JsonObject, PathfinderServices) - Method in class xyz.thepathfinder.android.Model: Updates the models routes.
Route - Class in xyz.thepathfinder.android: Route of the model.
Route(JsonObject, PathfinderServices) - Constructor for class xyz.thepathfinder.android.Route: Creates a route for a transport to perform.
route - Variable in class xyz.thepathfinder.android.Transport: Route of the transport.
route(JsonObject, PathfinderServices) - Method in class xyz.thepathfinder.android.Transport: Updates the models routes.
routed(List<Route>) - Method in class xyz.thepathfinder.android.ClusterListener: Invoked when the cluster receives a routed message.
routed(Route) - Method in class xyz.thepathfinder.android.CommodityListener: Invoked when the commodity receives a routed message.
routed(Route) - Method in class xyz.thepathfinder.android.TransportListener: Invoked when the transport receives a routed message.
routes - Variable in class xyz.thepathfinder.android.Cluster: List of routes for this cluster.
routeSubscribe() - Method in class xyz.thepathfinder.android.SubscribableModel: Subscribes to route updates from the server.
routeSubscribed(T) - Method in class xyz.thepathfinder.android.ModelListener: Invoked when the model receives a route subscribed message.
routeUnsubscribe() - Method in class xyz.thepathfinder.android.SubscribableModel: Unsubcribes from route updates from the server.
routeUnsubscribed(T) - Method in class xyz.thepathfinder.android.ModelListener: Invoked when the model receives a route unsubscribed message.

S

send(String) - Method in class xyz.thepathfinder.android.Connection: Sends a message through the web socket connection to the Pathfinder server.
sendAuthenticationMessage(String) - Method in class xyz.thepathfinder.android.Connection: Sends an authentication messages that bypasses the message queue.
sendMessage(String) - Method in class xyz.thepathfinder.android.Connection: Sends a text message through the web socket to the Pathfinder server if connected.
sendMessage(JsonObject) - Method in class xyz.thepathfinder.android.Model: Sends a json message through the web socket connection if connected.
sendSubscribeMessage(String) - Method in class xyz.thepathfinder.android.SubscribableModel: Sends a subscribe like message to the Pathfinder server.
sendToAuthenticationServer(String) - Method in class xyz.thepathfinder.android.Authenticator: Sends a post request to the authentication server with the connection id received from the pathfinder server to authenticate the user.
sentMessageCount - Variable in class xyz.thepathfinder.android.Connection: Number of messages sent through the web socket.
services - Variable in class xyz.thepathfinder.android.Authenticator: Access to the web socket connection.
services - Variable in class xyz.thepathfinder.android.Model: A pathfinder services object to have access to the model registry and the web socket.
services - Variable in class xyz.thepathfinder.android.ModelMessageHandler: Holds access to all the models.
services - Variable in class xyz.thepathfinder.android.Pathfinder: Keeps track of all the Pathfinder models and connection to the server.
session - Variable in class xyz.thepathfinder.android.Connection: The web socket session used to send messages through the web socket.
setCommodities(Iterable<Commodity>) - Method in class xyz.thepathfinder.android.Cluster: Sets this cluster's commodities.
setCommodities(Map<String, Commodity>) - Method in class xyz.thepathfinder.android.Cluster: Sets this cluster's commodities.
setCommodities(JsonArray) - Method in class xyz.thepathfinder.android.Transport: Sets the commodities being carried by the transport.
setConnected(boolean) - Method in class xyz.thepathfinder.android.Model: Sets if the model has connected with the Pathfinder server.
setEndLatitude(double) - Method in class xyz.thepathfinder.android.Commodity: Sets the end latitude field to a new latitude
setEndLongitude(double) - Method in class xyz.thepathfinder.android.Commodity: Sets the end longitude field to a new longitude
setLatitude(double) - Method in class xyz.thepathfinder.android.Transport: Sets the latitude of the transport.
setLongitude(double) - Method in class xyz.thepathfinder.android.Transport: Sets the longitude of the transport.
setMessageHandler(MessageHandler) - Method in class xyz.thepathfinder.android.Connection: Sets the web socket connection's message handler.
setMetadata(JsonObject) - Method in class xyz.thepathfinder.android.Commodity: Sets the metadata field to a new JSON object.
setMetadata(JsonObject) - Method in class xyz.thepathfinder.android.Transport: Sets the metadata of the transport.
setPathName(String) - Method in class xyz.thepathfinder.android.Model: Set the path of the model.
setPathName(String) - Method in class xyz.thepathfinder.android.Path: Set the path of the model.
setRoute(Route) - Method in class xyz.thepathfinder.android.Commodity: Sets the route field to a new route
setRoute(Route) - Method in class xyz.thepathfinder.android.Transport: Sets the route of the transport.
setRoutes(List<Route>) - Method in class xyz.thepathfinder.android.Cluster: Sets this cluster's routes.
setStartLatitude(double) - Method in class xyz.thepathfinder.android.Commodity: Sets the start latitude field to a new latitude
setStartLongitude(double) - Method in class xyz.thepathfinder.android.Commodity: Sets the start longitude field to a new longitude
setStatus(String) - Method in class xyz.thepathfinder.android.Commodity: Sets the status field to a new status
setStatus(CommodityStatus) - Method in class xyz.thepathfinder.android.Commodity: Sets the status field to a new status
setStatus(TransportStatus) - Method in class xyz.thepathfinder.android.Transport: Sets the status of the transport.
setSubclusters(Iterable<Cluster>) - Method in class xyz.thepathfinder.android.Cluster: Sets this cluster's sub-clusters.
setSubclusters(Map<String, Cluster>) - Method in class xyz.thepathfinder.android.Cluster: Sets this cluster's sub-clusters.
setTransportId(Long) - Method in class xyz.thepathfinder.android.Commodity: Sets the transport id field to a new transport.
setTransports(Iterable<Transport>) - Method in class xyz.thepathfinder.android.Cluster: Sets this cluster's transports.
setTransports(Map<String, Transport>) - Method in class xyz.thepathfinder.android.Cluster: Sets this cluster's transports.
startLatitude - Variable in class xyz.thepathfinder.android.Commodity: The pickup latitude of the commodity.
startLocationUpdated(double, double) - Method in class xyz.thepathfinder.android.CommodityListener: Invoked when the commodity's start location was updated by a message.
startLongitude - Variable in class xyz.thepathfinder.android.Commodity: The pickup longitude of the commodity.
status - Variable in class xyz.thepathfinder.android.Action: Represents the type of action to occur at that location.
status - Variable in enum xyz.thepathfinder.android.ActionStatus: The string representation of the status.
status - Variable in class xyz.thepathfinder.android.Commodity: The current status of this commodity.
status - Variable in enum xyz.thepathfinder.android.CommodityStatus: The string representation of the status.
status - Variable in class xyz.thepathfinder.android.Transport: Status of the transport.
status - Variable in enum xyz.thepathfinder.android.TransportStatus: The string representation of the status.
statuses - Static variable in enum xyz.thepathfinder.android.ActionStatus: Map of the possible statuses.
statuses - Static variable in enum xyz.thepathfinder.android.CommodityStatus: Map of the possible statuses.
statuses - Static variable in enum xyz.thepathfinder.android.TransportStatus: Map of the possible statuses.
statusUpdated(CommodityStatus) - Method in class xyz.thepathfinder.android.CommodityListener: Invoked when the commodity's status was updated by a message.
statusUpdated(TransportStatus) - Method in class xyz.thepathfinder.android.TransportListener: Invoked when the transport's status was updated by a message.
subclusterAdded(Cluster) - Method in class xyz.thepathfinder.android.ClusterListener: Invoked when a subcluster was added to this cluster by a message.
subclusterRemoved(Cluster) - Method in class xyz.thepathfinder.android.ClusterListener: Invoked when a subcluster was removed from this cluster by a message.
subclusters - Variable in class xyz.thepathfinder.android.Cluster: Maps a path in the form of a string to the sub-clusters directly under this cluster
subclustersUpdated(Collection<Cluster>) - Method in class xyz.thepathfinder.android.ClusterListener: Invoked when a sublcuster was updated from this cluster by a message.
subclusterUpdated(Cluster) - Method in class xyz.thepathfinder.android.ClusterListener: Invoked when a subcluster was updated from this cluster by a message.
SubscribableCrudModel<T extends SubscribableCrudModel<T,E>,E extends ModelListener<T>> - Class in xyz.thepathfinder.android: Access to CRUD and subscribe operations.
SubscribableCrudModel(String, ModelType, PathfinderServices) - Constructor for class xyz.thepathfinder.android.SubscribableCrudModel: Constructs a subscribable CRUD model.
SubscribableModel<T extends SubscribableModel<T,E>,E extends ModelListener<T>> - Class in xyz.thepathfinder.android: Access to subscribe operations on models.
SubscribableModel(String, ModelType, PathfinderServices) - Constructor for class xyz.thepathfinder.android.SubscribableModel: Constructs a subcribable model.
subscribe() - Method in class xyz.thepathfinder.android.SubscribableModel: Subscribes to the models updates from the server.
subscribed(T) - Method in class xyz.thepathfinder.android.ModelListener: Invoked when the model receives a subscribed message.

T

toJson() - Method in class xyz.thepathfinder.android.Cluster: Converts the Model to JSON.
toJson() - Method in class xyz.thepathfinder.android.Commodity: Converts the Model to JSON.
toJson() - Method in class xyz.thepathfinder.android.Model: Converts the Model to JSON.
toJson() - Method in class xyz.thepathfinder.android.Transport: Converts the Model to JSON.
toString() - Method in class xyz.thepathfinder.android.Action
toString() - Method in enum xyz.thepathfinder.android.ActionStatus
toString() - Method in class xyz.thepathfinder.android.Cluster
toString() - Method in class xyz.thepathfinder.android.Commodity
toString() - Method in enum xyz.thepathfinder.android.CommodityStatus
toString() - Method in enum xyz.thepathfinder.android.ModelType
toString() - Method in class xyz.thepathfinder.android.Route
toString() - Method in class xyz.thepathfinder.android.Transport
toString() - Method in enum xyz.thepathfinder.android.TransportStatus
transport - Variable in class xyz.thepathfinder.android.Route: Transport used for the route.
Transport - Class in xyz.thepathfinder.android: Interface to the Pathfinder server's transport API.
Transport(String, PathfinderServices) - Constructor for class xyz.thepathfinder.android.Transport: Constructs a transport model.
Transport(String, double, double, TransportStatus, JsonObject, List<Commodity>, PathfinderServices) - Constructor for class xyz.thepathfinder.android.Transport: Constructs a transport model with the specified values.
transportAdded(Transport) - Method in class xyz.thepathfinder.android.ClusterListener: Invoked when a transport was added to this cluster by a message.
transportId - Variable in class xyz.thepathfinder.android.Commodity: The transport caring the commodity.
TransportListener - Class in xyz.thepathfinder.android: The TransportListener interface gives developers access to notifications when a transport is modified.
TransportListener() - Constructor for class xyz.thepathfinder.android.TransportListener
transportRemoved(Transport) - Method in class xyz.thepathfinder.android.ClusterListener: Invoked when a transport was removed from this cluster by a message.
transports - Variable in class xyz.thepathfinder.android.Cluster: Maps a path in the form of a string to the transports directly under this cluster
TransportStatus - Enum in xyz.thepathfinder.android: An enum for the possible statuses of a Transport.
TransportStatus(String) - Constructor for enum xyz.thepathfinder.android.TransportStatus: A constructor to make each possible status.
transportsUpdated(Collection<Transport>) - Method in class xyz.thepathfinder.android.ClusterListener: Invoked when a transport was updated in this cluster by a message.
transportUpdated(Transport) - Method in class xyz.thepathfinder.android.ClusterListener: Invoked when a transport was updated in this cluster by a message.
transportUpdated(Transport) - Method in class xyz.thepathfinder.android.CommodityListener: Invoked when the commodity's transport is changed.
type - Variable in enum xyz.thepathfinder.android.ModelType: The string representation of the type.
types - Static variable in enum xyz.thepathfinder.android.ModelType: Map of the possible statuses.

U

unregisterModel(Path) - Method in class xyz.thepathfinder.android.ModelRegistry: Removes a Model from the registry.
unsubscribe() - Method in class xyz.thepathfinder.android.SubscribableModel: Unsubcribes from updates from the server.
unsubscribed(T) - Method in class xyz.thepathfinder.android.ModelListener: Invoked when the model receives an unsubscribed message.
update(Double, Double, Double, Double, CommodityStatus, JsonObject, Long) - Method in class xyz.thepathfinder.android.Commodity: Sends update requests to the Pathfinder server.
update(JsonObject) - Method in class xyz.thepathfinder.android.SubscribableCrudModel: Updates the model specified by the path on the server.
update(Double, Double, TransportStatus, JsonObject) - Method in class xyz.thepathfinder.android.Transport: Sends update requests to the Pathfinder server.
updated(T) - Method in class xyz.thepathfinder.android.ModelListener: Invoked when the model receives an updated message.
updateDroppedOff() - Method in class xyz.thepathfinder.android.Commodity: Updates the commodity to have a status of dropped off.
updateEndLocation(double, double) - Method in class xyz.thepathfinder.android.Commodity: Updates the end location of this commodity to specified coordinates.
updateFields(JsonObject) - Method in class xyz.thepathfinder.android.Cluster: Updates the fields of the model.
updateFields(JsonObject) - Method in class xyz.thepathfinder.android.Commodity: Updates the fields of the model.
updateFields(JsonObject) - Method in class xyz.thepathfinder.android.Model: Updates the fields of the model.
updateFields(JsonObject) - Method in class xyz.thepathfinder.android.Transport: Updates the fields of the model.
updateLocation(double, double) - Method in class xyz.thepathfinder.android.Transport: Updates the location of this transport to specified coordinates.
updateMetadata(JsonObject) - Method in class xyz.thepathfinder.android.Commodity: Updates the metadata of this commodity to the specified Json Object.
updateMetadata(JsonObject) - Method in class xyz.thepathfinder.android.Transport: Updates the metadata of this transport to the specified metadata.
updatePickedUp(Transport) - Method in class xyz.thepathfinder.android.Commodity: Updates the transport of this commodity to the specified transport and sets the status to picked up.
updateStartLocation(double, double) - Method in class xyz.thepathfinder.android.Commodity: Updates the start location of this commodity to specified coordinates.
updateStatus(CommodityStatus) - Method in class xyz.thepathfinder.android.Commodity: Updates the status of this commodity to the specified status.
updateStatus(TransportStatus) - Method in class xyz.thepathfinder.android.Transport: Updates the status of this transport to the specified status.
updateType(String, JsonObject) - Method in class xyz.thepathfinder.android.Model: Invokes the model unspecific notifications.
userCredential - Variable in class xyz.thepathfinder.android.Authenticator: String version of a JWT for the user's credentials.

V

valueOf(String) - Static method in enum xyz.thepathfinder.android.ActionStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum xyz.thepathfinder.android.CommodityStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum xyz.thepathfinder.android.ModelType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum xyz.thepathfinder.android.TransportStatus: Returns the enum constant of this type with the specified name.
values() - Static method in enum xyz.thepathfinder.android.ActionStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum xyz.thepathfinder.android.CommodityStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum xyz.thepathfinder.android.ModelType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum xyz.thepathfinder.android.TransportStatus: Returns an array containing the constants of this enum type, in the order they are declared.

W

webSocketUrl - Variable in class xyz.thepathfinder.android.Pathfinder: URL to the Pathfinder server being connected to.

X

xyz.thepathfinder.android - package xyz.thepathfinder.android

A C D E F G H I L M N O P R S T U V W X