com.garmin.fit
Class FileEncoder

java.lang.Object
  extended by com.garmin.fit.FileEncoder
All Implemented Interfaces:
MesgDefinitionListener, MesgListener

public class FileEncoder
extends java.lang.Object
implements MesgListener, MesgDefinitionListener

Encodes message objects into a FIT binary file.


Constructor Summary
FileEncoder()
           
FileEncoder(java.io.File file)
          Deprecated. Encoder now supports encoding files of differing protocol versions, use FileEncoder(File, Fit.ProtocolVersion) to ensure the encoder is validating your files correctly
FileEncoder(java.io.File file, Fit.ProtocolVersion version)
          Constructs a new File Encoder for specified file
 
Method Summary
 void close()
          Updates the data size in the file header, writes the CRC, and closes the file.
 void onMesg(Mesg mesg)
          MesgListener interface.
 void onMesgDefinition(MesgDefinition mesgDefinition)
          MesgDefinitionListener interface.
 void open(java.io.File file)
          Opens file for writing.
 void write(java.util.List<Mesg> mesgs)
          Writes a list of messages to the file.
 void write(Mesg mesg)
          Writes a message to the file.
 void write(MesgDefinition mesgDefinition)
          Writes a message definition to the file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileEncoder

public FileEncoder()

FileEncoder

@Deprecated
public FileEncoder(java.io.File file)
Deprecated. Encoder now supports encoding files of differing protocol versions, use FileEncoder(File, Fit.ProtocolVersion) to ensure the encoder is validating your files correctly

Constructs a new File Encoder for specified file. Forces ProtocolVersion.V1_0

Parameters:
file - File to write

FileEncoder

public FileEncoder(java.io.File file,
                   Fit.ProtocolVersion version)
Constructs a new File Encoder for specified file

Parameters:
file - File to write
version - Fit Protocol Version to use when writing files
Method Detail

open

public void open(java.io.File file)
Opens file for writing. If the file already exists it will be overwritten.

Parameters:
file - file to write

onMesg

public void onMesg(Mesg mesg)
MesgListener interface.

Specified by:
onMesg in interface MesgListener

onMesgDefinition

public void onMesgDefinition(MesgDefinition mesgDefinition)
MesgDefinitionListener interface.

Specified by:
onMesgDefinition in interface MesgDefinitionListener

write

public void write(MesgDefinition mesgDefinition)
Writes a message definition to the file.

Parameters:
mesgDefinition - message definition object to write

write

public void write(Mesg mesg)
Writes a message to the file. Automatically writes message definition if required.

Parameters:
mesg - message object to write

write

public void write(java.util.List<Mesg> mesgs)
Writes a list of messages to the file.

Parameters:
mesgs - list message objects to write

close

public void close()
Updates the data size in the file header, writes the CRC, and closes the file.