jef.dna.attributes.impl
Class SourceFileAttribute

java.lang.Object
  extended by jef.dna.attributes.impl.GenericAttribute
      extended by jef.dna.attributes.impl.SourceFileAttribute
All Implemented Interfaces:
java.lang.Cloneable, Attribute, SourceFileAttribute, BytesCountable

public class SourceFileAttribute
extends GenericAttribute
implements SourceFileAttribute

Class representing a Source File Attribute.

Author:
frusso

Field Summary
protected static Logger logger
           
 
Fields inherited from class jef.dna.attributes.impl.GenericAttribute
attribFactory, attributeNameIndex, dna, instrFactory
 
Constructor Summary
SourceFileAttribute()
          Creates a new instance of SourceFileAttribute
 
Method Summary
 java.lang.Object clone()
          The clone() method will return a new instance whose reference to the containing Dna instance is set to null.
 void fromStream(java.io.DataInputStream dis, Dna dna, int indexName, int length)
          This method reads the data with which the attribute has to be initialized.
 int getBytesCount()
          This method must return the overall number of bytes required by the component implementing this interface.
 int getSourceFileIndex()
          The value of the sourcefile_index item must be a valid index into the constant_pool table.
protected  void innerValidations(ConstantPoolTable cpt)
           
 void setSourceFileIndex(int srcFileIndex)
          The value of the sourcefile_index item must be a valid index into the constant_pool table.
 void toStream(java.io.DataOutputStream dos)
          This method writes the attribute to the provided output stream.
 void updateRefs(int offset)
          This method updates all the references pointing to constant pool table's entries this attributes holds.
 
Methods inherited from class jef.dna.attributes.impl.GenericAttribute
getDna, getLength, getNameIndex, setDna, setNameIndex, validate, validateNameIndex
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface jef.dna.attributes.Attribute
getDna, getLength, getNameIndex, setDna, setNameIndex, validate
 

Field Detail

logger

protected static Logger logger
Constructor Detail

SourceFileAttribute

public SourceFileAttribute()
Creates a new instance of SourceFileAttribute

Method Detail

setSourceFileIndex

public void setSourceFileIndex(int srcFileIndex)
Description copied from interface: SourceFileAttribute
The value of the sourcefile_index item must be a valid index into the constant_pool table. The constant pool entry at that index must be a CONSTANT_Utf8_info structure representing a string.

Specified by:
setSourceFileIndex in interface SourceFileAttribute
Parameters:
srcFileIndex - A valid index into the constant pool table as described above

getSourceFileIndex

public int getSourceFileIndex()
Description copied from interface: SourceFileAttribute
The value of the sourcefile_index item must be a valid index into the constant_pool table. The constant pool entry at that index must be a CONSTANT_Utf8_info structure representing a string.

Specified by:
getSourceFileIndex in interface SourceFileAttribute
Returns:
int A valid index into the constant pool table as described above

toStream

public void toStream(java.io.DataOutputStream dos)
              throws DnaSerializationException
Description copied from interface: Attribute
This method writes the attribute to the provided output stream.

Specified by:
toStream in interface Attribute
Parameters:
dos - The output stream
Throws:
DnaSerializationException - Errors while writing the attribute to the output stream

fromStream

public void fromStream(java.io.DataInputStream dis,
                       Dna dna,
                       int indexName,
                       int length)
                throws DnaDeserializationException,
                       MissingDnaContainerException
Description copied from interface: Attribute
This method reads the data with which the attribute has to be initialized.

Specified by:
fromStream in interface Attribute
Parameters:
dis - The input stream
dna - The Dna instance this class belongs to
indexName - The value of the name index
length - The length of the attribute
Throws:
DnaDeserializationException - Errors while reading the attribute from the stream
MissingDnaContainerException - There is no reference to the current Dna container

updateRefs

public void updateRefs(int offset)
Description copied from interface: Attribute
This method updates all the references pointing to constant pool table's entries this attributes holds.

Specified by:
updateRefs in interface Attribute
Specified by:
updateRefs in class GenericAttribute
Parameters:
offset - The offset

innerValidations

protected void innerValidations(ConstantPoolTable cpt)
                         throws AttributeValidationException,
                                AttributeOutOfRangeException,
                                MissingDnaContainerException,
                                MissingCPTableException
Overrides:
innerValidations in class GenericAttribute
Throws:
AttributeValidationException
AttributeOutOfRangeException
MissingDnaContainerException
MissingCPTableException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
The clone() method will return a new instance whose reference to the containing Dna instance is set to null. It is up to you appropriately setting it to the correct value.

Specified by:
clone in interface Attribute
Overrides:
clone in class GenericAttribute
Throws:
java.lang.CloneNotSupportedException

getBytesCount

public int getBytesCount()
Description copied from interface: BytesCountable
This method must return the overall number of bytes required by the component implementing this interface.

Specified by:
getBytesCount in interface BytesCountable