com.oziexplorer
Class WaypointFile

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<E>
          extended by java.util.ArrayList<T>
              extended by com.oziexplorer.DataFile<Waypoint>
                  extended by com.oziexplorer.WaypointFile
All Implemented Interfaces:
Serializable, Cloneable, Iterable<Waypoint>, Collection<Waypoint>, List<Waypoint>, RandomAccess

public class WaypointFile
extends DataFile<Waypoint>

Read and write OziExplorer waypoint files.

See Also:
Serialized Form

Field Summary
protected  String datum
          The waypoint list datum.
protected  String gpsType
           
protected  int reserved
          Reserved field - unknown use.
 
Fields inherited from class com.oziexplorer.DataFile
C, L, SepRE, T
 
Fields inherited from class java.util.AbstractList
modCount
 
Constructor Summary
WaypointFile()
          Create a new waypoint file reader/writer.
 
Method Summary
 void clear()
          Clear any current contents of the waypoint list.
 void display()
          Display the waypoints on the map.
 String getDatum()
          Get the waypoint list datum.
 String getGpsType()
          Get the GPS type.
 int getReserved()
          Get the value of the reserved field.
 void read(File file)
          Read a waypoint list from the specified File.
 void read(InputStream input)
          Read a waypoint list from the specified InputStream.
 void read(String file)
          Read a waypoint list from the specified file.
 void setDatum(String datum)
          Set the waypoint list datum.
 void setGpsType(String gpsType)
          Set the GPS type.
 void setReserved(int reserved)
          Set the value of the reserved field.
 void write(File file)
          Write a waypoint list to the specified File.
 void write(OutputStream output)
          Write a waypoint list to the specified OutputStream.
 void write(String file)
          Write a waypoint list to the specified file.
 
Methods inherited from class com.oziexplorer.DataFile
calendarToOziDate, escapeCommas, getDate, getDouble, getInt, getString, newOziException, newOziException, newScanner, oziDateToCalendar, skipNext, unescapeCommas
 
Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, removeRange, set, size, toArray, toArray, trimToSize
 
Methods inherited from class java.util.AbstractList
equals, hashCode, iterator, listIterator, listIterator, subList
 
Methods inherited from class java.util.AbstractCollection
containsAll, removeAll, retainAll, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList
 

Field Detail

datum

protected String datum
The waypoint list datum.


reserved

protected int reserved
Reserved field - unknown use.


gpsType

protected String gpsType
Constructor Detail

WaypointFile

public WaypointFile()
Create a new waypoint file reader/writer.

Method Detail

clear

public void clear()
Clear any current contents of the waypoint list.

Specified by:
clear in interface Collection<Waypoint>
Specified by:
clear in interface List<Waypoint>
Overrides:
clear in class ArrayList<Waypoint>

read

public void read(File file)
          throws OziException
Read a waypoint list from the specified File.

Parameters:
file - the file to read from.
Throws:
OziException - if there is a problem reading the file.

read

public void read(String file)
          throws OziException
Read a waypoint list from the specified file.

Parameters:
file - the file to read from.
Throws:
OziException - if there is a problem reading the file.

read

public void read(InputStream input)
          throws OziException
Read a waypoint list from the specified InputStream.

Parameters:
input - the input stream to read from.
Throws:
OziException - if there is a problem reading the file.

write

public void write(File file)
           throws OziException
Write a waypoint list to the specified File.

Parameters:
file - the file to write to.
Throws:
OziException - if there is a problem writing the file.

write

public void write(String file)
           throws OziException
Write a waypoint list to the specified file.

Parameters:
file - the file to write to.
Throws:
OziException - if there is a problem writing the file.

write

public void write(OutputStream output)
           throws OziException
Write a waypoint list to the specified OutputStream.

Parameters:
output - the input stream to write to.
Throws:
OziException - if there is a problem writing the file.

display

public void display()
             throws OziException
Display the waypoints on the map.

Throws:
OziException - if there is a problem displaying the waypoints.

getDatum

public String getDatum()
Get the waypoint list datum.

Returns:
the waypoint list datum.

setDatum

public void setDatum(String datum)
Set the waypoint list datum.

Parameters:
datum - the waypoint list datum.

getReserved

public int getReserved()
Get the value of the reserved field.

Returns:
the value of the reserved field.

setReserved

public void setReserved(int reserved)
Set the value of the reserved field.

Parameters:
reserved - the value of the reserved field.

getGpsType

public String getGpsType()
Get the GPS type.

Returns:
the GPS type.

setGpsType

public void setGpsType(String gpsType)
Set the GPS type.

Parameters:
gpsType - the GPS type.