org.codehaus.metaclass.io
Class MetaClassIOBinary

java.lang.Object
  extended byorg.codehaus.metaclass.io.AbstractMetaClassIO
      extended byorg.codehaus.metaclass.io.MetaClassIOBinary
All Implemented Interfaces:
MetaClassIO

public class MetaClassIOBinary
extends org.codehaus.metaclass.io.AbstractMetaClassIO

This is a utility class that writes out a Attributes object to a stream using binary format outlined in documentation.

Version:
$Revision: 1.25 $ $Date: 2003/12/11 08:41:50 $
Author:
Peter Donald, Doug Hagan

Field Summary
static java.lang.String EXTENSION
          Extension of metadata files that are in binary format.
static MetaClassIOBinary IO
          Constant with instance of MetaClassIO.
 
Constructor Summary
MetaClassIOBinary()
           
 
Method Summary
 ClassDescriptor deserializeClass(java.io.InputStream input)
          Read a ClassDescriptor from an input stream.
 java.lang.String getResourceName(java.lang.String classname)
          Get the name of resource the metadata is stored in for specified class.
 void serializeClass(java.io.OutputStream output, ClassDescriptor descriptor)
          Implement in subclasses to actually serialize descriptor.
 void writeDescriptor(java.io.File baseDir, ClassDescriptor descriptor)
          Write a ClassDescriptor to a file relative to specified base directory.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IO

public static final MetaClassIOBinary IO
Constant with instance of MetaClassIO.


EXTENSION

public static final java.lang.String EXTENSION
Extension of metadata files that are in binary format.

See Also:
Constant Field Values
Constructor Detail

MetaClassIOBinary

public MetaClassIOBinary()
Method Detail

getResourceName

public java.lang.String getResourceName(java.lang.String classname)
Description copied from interface: MetaClassIO
Get the name of resource the metadata is stored in for specified class.

Parameters:
classname - the name of class
Returns:
the resource name
See Also:
MetaClassIO.getResourceName(String)

deserializeClass

public ClassDescriptor deserializeClass(java.io.InputStream input)
                                 throws java.io.IOException
Description copied from interface: MetaClassIO
Read a ClassDescriptor from an input stream.

Parameters:
input - the input stream
Returns:
the ClassDescriptor
Throws:
java.io.IOException
See Also:
MetaClassIO.deserializeClass(java.io.InputStream)

serializeClass

public void serializeClass(java.io.OutputStream output,
                           ClassDescriptor descriptor)
                    throws java.io.IOException
Description copied from class: org.codehaus.metaclass.io.AbstractMetaClassIO
Implement in subclasses to actually serialize descriptor.

Parameters:
output - the output stream
descriptor - the descriptor
Throws:
java.io.IOException
See Also:
AbstractMetaClassIO#serializeClass(OutputStream, ClassDescriptor)

writeDescriptor

public void writeDescriptor(java.io.File baseDir,
                            ClassDescriptor descriptor)
                     throws java.lang.Exception
Description copied from interface: MetaClassIO
Write a ClassDescriptor to a file relative to specified base directory.

Specified by:
writeDescriptor in interface MetaClassIO
Parameters:
baseDir - the base directory to output to.
descriptor - the ClassDescriptor to write out.
Throws:
java.lang.Exception - if unable ot write class descriptor.
See Also:
MetaClassIO.writeDescriptor(File, ClassDescriptor)


Copyright © 2003-2004 Codehaus. All Rights Reserved.