|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.batik.ext.awt.image.spi.AbstractRegistryEntry
org.apache.batik.ext.awt.image.spi.MagicNumberRegistryEntry
public abstract class MagicNumberRegistryEntry
This Image tag registry entry is built around the notion of magic numbers. These are strings of bytes that are at a well known location in the input stream (often the start). This base class can handle the compatiblity check based on a list of Magic Numbers that correspond to your format (Some formats have multiple magic numbers associated with them).
Nested Class Summary | |
---|---|
static class |
MagicNumberRegistryEntry.MagicNumber
Inner class that represents one magic number. |
Field Summary | |
---|---|
static float |
PRIORITY
|
Fields inherited from interface org.apache.batik.ext.awt.image.spi.ErrorConstants |
---|
ERR_STREAM_FORMAT_UNREADABLE, ERR_STREAM_UNREADABLE, ERR_URL_FORMAT_UNREADABLE, ERR_URL_UNINTERPRETABLE, ERR_URL_UNREACHABLE, RESOURCES |
Constructor Summary | |
---|---|
MagicNumberRegistryEntry(String name,
float priority,
String[] exts,
String[] mimeTypes,
int offset,
byte[] magicNumber)
Constructor, simplifies construction of entry when only one magic number is required. |
|
MagicNumberRegistryEntry(String name,
float priority,
String[] exts,
String[] mimeTypes,
MagicNumberRegistryEntry.MagicNumber[] magicNumbers)
Constructor |
|
MagicNumberRegistryEntry(String name,
float priority,
String ext,
String mimeType,
int offset,
byte[] magicNumber)
Constructor, simplifies construction of entry when only one extension and one magic number is required. |
|
MagicNumberRegistryEntry(String name,
float priority,
String ext,
String mimeType,
MagicNumberRegistryEntry.MagicNumber[] magicNumbers)
Constructor, simplifies construction of entry when only one extension is required. |
|
MagicNumberRegistryEntry(String name,
String[] exts,
String[] mimeTypes,
int offset,
byte[] magicNumbers)
Constructor, simplifies construction of entry when only one magic number is required. |
|
MagicNumberRegistryEntry(String name,
String[] exts,
String[] mimeTypes,
MagicNumberRegistryEntry.MagicNumber[] magicNumbers)
Constructor |
|
MagicNumberRegistryEntry(String name,
String[] exts,
String[] mimeTypes,
MagicNumberRegistryEntry.MagicNumber[] magicNumbers,
float priority)
Constructor, allows for overriding the default priority of magic number entries. |
|
MagicNumberRegistryEntry(String name,
String ext,
String mimeType,
int offset,
byte[] magicNumber)
Constructor, simplifies construction of entry when only one extension and one magic number is required. |
|
MagicNumberRegistryEntry(String name,
String ext,
String mimeType,
MagicNumberRegistryEntry.MagicNumber[] magicNumbers)
Constructor, simplifies construction of entry when only one extension is required. |
Method Summary | |
---|---|
int |
getReadlimit()
Returns the maximume read ahead needed for all magic numbers. |
boolean |
isCompatibleStream(InputStream is)
Check if the stream contains an image that can be handled by this format handler |
Methods inherited from class org.apache.batik.ext.awt.image.spi.AbstractRegistryEntry |
---|
getFormatName, getMimeTypes, getPriority, getStandardExtensions |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.batik.ext.awt.image.spi.StreamRegistryEntry |
---|
handleStream |
Methods inherited from interface org.apache.batik.ext.awt.image.spi.RegistryEntry |
---|
getFormatName, getMimeTypes, getPriority, getStandardExtensions |
Field Detail |
---|
public static final float PRIORITY
Constructor Detail |
---|
public MagicNumberRegistryEntry(String name, float priority, String ext, String mimeType, int offset, byte[] magicNumber)
name
- Format Namepriority
- the priority of the RegistryEntryext
- Standard extensionmimeType
- the supported MIME typeoffset
- Offset of magic numbermagicNumber
- byte array to match.public MagicNumberRegistryEntry(String name, String ext, String mimeType, int offset, byte[] magicNumber)
name
- Format Nameext
- Standard extensionmimeType
- the supported MIME typeoffset
- Offset of magic numbermagicNumber
- byte array to match.public MagicNumberRegistryEntry(String name, float priority, String ext, String mimeType, MagicNumberRegistryEntry.MagicNumber[] magicNumbers)
name
- Format Namepriority
- the priority of the RegistryEntryext
- Standard extensionmimeType
- the supported MIME typemagicNumbers
- Array of magic numbers any of which can match.public MagicNumberRegistryEntry(String name, String ext, String mimeType, MagicNumberRegistryEntry.MagicNumber[] magicNumbers)
name
- Format Nameext
- Standard extensionmimeType
- the supported MIME typemagicNumbers
- Array of magic numbers any of which can match.public MagicNumberRegistryEntry(String name, float priority, String[] exts, String[] mimeTypes, int offset, byte[] magicNumber)
name
- Format Namepriority
- the priority of the RegistryEntryexts
- Standard set of extensionsmimeTypes
- array of supported MIME typesoffset
- Offset of magic numbermagicNumber
- byte array to match.public MagicNumberRegistryEntry(String name, String[] exts, String[] mimeTypes, int offset, byte[] magicNumbers)
name
- Format Nameexts
- Standard set of extensionsmimeTypes
- array of supported MIME typesoffset
- Offset of magic numbermagicNumbers
- byte array to match.public MagicNumberRegistryEntry(String name, float priority, String[] exts, String[] mimeTypes, MagicNumberRegistryEntry.MagicNumber[] magicNumbers)
name
- Format Namepriority
- the priority of the RegistryEntryexts
- Standard set of extensionsmimeTypes
- array of supported MIME typesmagicNumbers
- array of magic numbers any of which can match.public MagicNumberRegistryEntry(String name, String[] exts, String[] mimeTypes, MagicNumberRegistryEntry.MagicNumber[] magicNumbers)
name
- Format Nameexts
- Standard set of extensionsmimeTypes
- array of supported MIME typesmagicNumbers
- array of magic numbers any of which can match.public MagicNumberRegistryEntry(String name, String[] exts, String[] mimeTypes, MagicNumberRegistryEntry.MagicNumber[] magicNumbers, float priority)
name
- Format Nameexts
- Standard set of extensionsmagicNumbers
- array of magic numbers any of which can match.priority
- The priority of this entry (1000 is baseline)Method Detail |
---|
public int getReadlimit()
getReadlimit
in interface StreamRegistryEntry
public boolean isCompatibleStream(InputStream is) throws StreamCorruptedException
isCompatibleStream
in interface StreamRegistryEntry
StreamCorruptedException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |