com.atakmap.android.vehicle.model

Class VehicleModelCache

java.lang.Object

com.atakmap.android.vehicle.model.VehicleModelCache

public class VehicleModelCache
extends java.lang.Object

Cache vehicle model data for re-use across multiple instances

Field Summary

Fields

Modifier and Type	Field and Description
static java.io.File	DIR
static java.io.File	ICON_DIR

Constructor Summary

Constructors

Constructor and Description
VehicleModelCache()

Method Summary

Modifier and Type	Method and Description
void	addVehicle(VehicleModelInfo vehicle) Add a vehicle to the cache (typically used by plugins)
void	dispose()
VehicleModelInfo	get(java.lang.String category, java.lang.String vehicle) Get specific vehicle model based on the vehicle category and type
java.util.List<VehicleModelInfo>	getAll() Get all vehicle model data
java.util.List<VehicleModelInfo>	getAll(java.lang.String category) Get all vehicle model data for a given category
java.util.List<java.lang.String>	getCategories() Get a list of all vehicle categories sorted alphabetically
static VehicleModelCache	getInstance()
boolean	registerUsage(VehicleModelInfo info, java.lang.String uid) Register usage of a specific vehicle model
void	removeVehicle(VehicleModelInfo vehicle) Remove vehicle from the cache (typically used by plugins)
void	rescan() Rescan the atak/tools/vehicles/models directory
boolean	unregisterUsage(VehicleModelInfo info, java.lang.String uid) Unregister usage of a specific vehicle model

Methods inherited from class java.lang.Object

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

Field Detail

DIR

public static final java.io.File DIR

ICON_DIR

public static final java.io.File ICON_DIR

Constructor Detail

VehicleModelCache

public VehicleModelCache()

Method Detail

getInstance

public static VehicleModelCache getInstance()

get

public VehicleModelInfo get(java.lang.String category,
                            java.lang.String vehicle)

Get specific vehicle model based on the vehicle category and type

Parameters:

category - Vehicle category

vehicle - Vehicle type (i.e. C-130)

Returns:

Vehicle model data

getAll

public java.util.List<VehicleModelInfo> getAll()

Get all vehicle model data

Returns:

Vehicle model data

getAll

public java.util.List<VehicleModelInfo> getAll(java.lang.String category)

Get all vehicle model data for a given category

Parameters:

category - Vehicle category

Returns:

List of vehicle model data

getCategories

public java.util.List<java.lang.String> getCategories()

Get a list of all vehicle categories sorted alphabetically

Returns:

List of vehicle categories

addVehicle

public void addVehicle(VehicleModelInfo vehicle)

Add a vehicle to the cache (typically used by plugins)

Parameters:

vehicle - Vehicle info to add

removeVehicle

public void removeVehicle(VehicleModelInfo vehicle)

Remove vehicle from the cache (typically used by plugins)

Parameters:

vehicle - Vehicle info to remove

registerUsage

public boolean registerUsage(VehicleModelInfo info,
                             java.lang.String uid)

Register usage of a specific vehicle model

Parameters:

info - Vehicle model info

uid - The UID of the object using it

Returns:

True if this the first registered of this model (since being empty)

unregisterUsage

public boolean unregisterUsage(VehicleModelInfo info,
                               java.lang.String uid)

Unregister usage of a specific vehicle model

Parameters:

info - Vehicle model info

uid - UID of the object using it

Returns:

True if this was the last usage of this model

dispose

public void dispose()

rescan

public void rescan()

Rescan the atak/tools/vehicles/models directory