Class Box
java.lang.Object
com.sun.media.imageioimpl.plugins.jpeg2000.Box
- Direct Known Subclasses:
BitsPerComponentBox,ChannelDefinitionBox,ColorSpecificationBox,ComponentMappingBox,DataEntryURLBox,FileTypeBox,HeaderBox,PaletteBox,ResolutionBox,SignatureBox,UUIDBox,UUIDListBox,XMLBox
This class is defined to create the box of JP2 file format. A box has
a length, a type, an optional extra length and its content. The subclasses
should explain the content information.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected byte[]protected longprotected intBox length, extra length, type and content data arrayprotected int -
Constructor Summary
ConstructorsConstructorDescriptionBox(int length, int type, byte[] data) Constructs aBoxinstance using the provided the box type and the box content in byte array format.Box(int length, int type, long extraLength, byte[] data) Constructs aBoxinstance using the provided the box type, the box extra length, and the box content in byte array format.Box(ImageInputStream iis, int pos) Constructs aBoxinstance from the providedImageInputStreamat the specified position.Constructs a Box from an "unknown" Node. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcompose()Composes the content byte array from the data elements.static voidcopyInt(byte[] data, int pos, int value) Copies that four bytes of an integer into the byte array.static BoxCreates aBoxobject with the providedtypebased on the provided Node object based on reflection.static ObjectgetAttribute(Node node, String name) Extracts the value of the attribute from name.static ClassgetBoxClass(int type) Returns the Box class for the box with the providedtype.protected static byte[]getByteArrayElementValue(Node node) Gets the byte array from anIIOMetadataNode.protected static bytegetByteElementValue(Node node) Gets its byte value from anIIOMetadataNode.byte[]Returns the box content in byte array.longReturns the box extra length.protected static int[]getIntArrayElementValue(Node node) Gets the integer array from anIIOMetadataNode.protected static intgetIntElementValue(Node node) Gets its integer value from anIIOMetadataNode.intReturns the box length.static StringgetName(int type) Returns the XML tag name defined in JP2 XML xsd/dtd for the box with the providedtype.Creates anIIOMetadataNodefrom this box.protected IIOMetadataNodeCreates anIIOMetadataNodefrom this box.protected static shortgetShortElementValue(Node node) Gets its short value from anIIOMetadataNode.protected static StringgetStringElementValue(Node node) Gets itsStringvalue from anIIOMetadataNode.intgetType()Returns the box type.static StringgetTypeByName(String name) Returns the type String based on the provided name.static intgetTypeInt(String s) Converts the box type from integer to string.static StringgetTypeString(int type) Converts the box type from integer to string.protected voidparse(byte[] data) Parses the data elements from the byte array.static byte[]parseByteArray(String value) Parses the byte array expressed by a string.protected static int[]parseIntArray(String value) Parses the integer array expressed a string.voidread(ImageInputStream iis, int pos) Reads a box from theImageInputStream</code.voidsetContent(byte[] data) Sets the box content.protected voidSets the default attributes, "Length", "Type", and "ExtraLength", to the providedIIOMetadataNode.voidsetExtraLength(long extraLength) Sets the box extra length length to the provided value.voidsetLength(int length) Sets the box length to the provided value.voidwrite(ImageOutputStream ios) Writes this box instance into aImageOutputStream.
-
Field Details
-
length
protected int lengthBox length, extra length, type and content data array -
extraLength
protected long extraLength -
type
protected int type -
data
protected byte[] data
-
-
Constructor Details
-
Box
public Box(int length, int type, byte[] data) Constructs aBoxinstance using the provided the box type and the box content in byte array format.- Parameters:
length- The provided box length.type- The provided box type.data- The provided box content in a byte array.- Throws:
IllegalArgumentException- If the length of the content byte array is not length - 8.
-
Box
public Box(int length, int type, long extraLength, byte[] data) Constructs aBoxinstance using the provided the box type, the box extra length, and the box content in byte array format. In this case, the length of the box is set to 1, which indicates the extra length is meaningful.- Parameters:
length- The provided box length.type- The provided box type.extraLength- The provided box extra length.data- The provided box content in a byte array.- Throws:
IllegalArgumentException- If the length of the content byte array is not extra length - 16.
-
Box
Constructs aBoxinstance from the providedImageInputStreamat the specified position.- Parameters:
iis- TheImageInputStreamcontains the box.pos- The position from where to read the box.- Throws:
IOException- If any IOException is thrown in the called read methods.
-
Box
Constructs a Box from an "unknown" Node. This node has at least the attribute "Type", and may have the attribute "Length", "ExtraLength" and a child "Content". The child node content is a IIOMetaDataNode with a byte[] user object.- Throws:
IIOInvalidTreeException
-
-
Method Details
-
getName
Returns the XML tag name defined in JP2 XML xsd/dtd for the box with the providedtype. If thetypeis not known, the string"unknown"is returned. -
getBoxClass
Returns the Box class for the box with the providedtype. -
getTypeByName
Returns the type String based on the provided name. -
createBox
Creates aBoxobject with the providedtypebased on the provided Node object based on reflection.- Throws:
IIOInvalidTreeException
-
getAttribute
Extracts the value of the attribute from name. -
parseByteArray
Parses the byte array expressed by a string. -
parseIntArray
Parses the integer array expressed a string. -
getStringElementValue
Gets itsStringvalue from anIIOMetadataNode. -
getByteElementValue
Gets its byte value from anIIOMetadataNode. -
getIntElementValue
Gets its integer value from anIIOMetadataNode. -
getShortElementValue
Gets its short value from anIIOMetadataNode. -
getByteArrayElementValue
Gets the byte array from anIIOMetadataNode. -
getIntArrayElementValue
Gets the integer array from anIIOMetadataNode. -
copyInt
public static void copyInt(byte[] data, int pos, int value) Copies that four bytes of an integer into the byte array. Necessary for the subclasses to compose the content array from the data elements -
getTypeString
Converts the box type from integer to string. This is necessary because type is defined as String in xsd/dtd and integer in the box classes. -
getTypeInt
Converts the box type from integer to string. This is necessary because type is defined as String in xsd/dtd and integer in the box classes. -
getNativeNode
Creates anIIOMetadataNodefrom this box. The format of this node is defined in the XML dtd and xsd for the JP2 image file. -
getNativeNodeForSimpleBox
Creates anIIOMetadataNodefrom this box. The format of this node is defined in the XML dtd and xsd for the JP2 image file. This method is designed for the types of boxes whose XML tree only has 2 levels. -
setDefaultAttributes
Sets the default attributes, "Length", "Type", and "ExtraLength", to the providedIIOMetadataNode. -
getLength
public int getLength()Returns the box length. -
getType
public int getType()Returns the box type. -
getExtraLength
public long getExtraLength()Returns the box extra length. -
getContent
public byte[] getContent()Returns the box content in byte array. -
setLength
public void setLength(int length) Sets the box length to the provided value. -
setExtraLength
public void setExtraLength(long extraLength) Sets the box extra length length to the provided value. -
setContent
public void setContent(byte[] data) Sets the box content. If the content length is not length -8 or extra length - 16, IllegalArgumentException will be thrown. -
write
Writes this box instance into aImageOutputStream.- Throws:
IOException
-
read
Reads a box from theImageInputStream</code. at the provided position.- Throws:
IOException
-
parse
protected void parse(byte[] data) Parses the data elements from the byte array. The subclasses should override this method. -
compose
protected void compose()Composes the content byte array from the data elements.
-