ihs.apcs.spacebattle

Class RadarResults

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<ObjectStatus>

ihs.apcs.spacebattle.RadarResults

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<ObjectStatus>, java.util.Collection<ObjectStatus>, java.util.List<ObjectStatus>, java.util.RandomAccess

public class RadarResults
extends java.util.ArrayList<ObjectStatus>

Represents the results of a radar sweep.

Each radar sweep will return a collection of ObjectStatus objects representing the objects in range of the radar sweep. If a level 1, 2, or 4 sweep was performed, these ObjectStatuses will not be fully populated. Attempting to access data that was not determined by the radar sweep will result in a zero-equivalent value.

Since:

0.1

See Also:

RadarCommand, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RadarResults()

Method Summary

Methods

Modifier and Type	Method and Description
ObjectStatus	getById(int id) Gets the details read by this radar sweep for a particular object whose ID is previously known.
ObjectStatus	getByPosition(Point pos) Gets the details read by this radar sweep for a particular object whose location is previously known.
java.util.List<ObjectStatus>	getByType(java.lang.String type) Gets the details read by this radar sweep for all objects of the given type.
int	getNumObjects() Gets the number of objects detected by this radar sweep.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Constructor Detail

RadarResults

public RadarResults()

Method Detail

getNumObjects

public int getNumObjects()

Gets the number of objects detected by this radar sweep.

Note: for a level 3 sweep, this will be either 0 or 1.

Returns:

the number of objects detected by the radar sweep

getById

public ObjectStatus getById(int id)

Gets the details read by this radar sweep for a particular object whose ID is previously known.

Parameters:

id - the ID of the object to lookup

Returns:

the radar details for the given object, or null if the object was not detected in this sweep

getByPosition

public ObjectStatus getByPosition(Point pos)

Gets the details read by this radar sweep for a particular object whose location is previously known.

Parameters:

pos - the position of the object to lookup

Returns:

the radar details for the given object, or null if the object was not detected in this sweep

getByType

public java.util.List<ObjectStatus> getByType(java.lang.String type)

Gets the details read by this radar sweep for all objects of the given type. Case-insensitive comparison is used for type names.

Could be Ship, Planet, BlackHole, Star, Nebula, Asteroid, Torpedo, Bauble, Bubble, or Outpost.

Parameters:

type - the type of object for which to return results

Returns:

a list of radar details for all objects of the given type (may be empty)