APIdia Launch Partner
Top Description Inners Methods
com.sun.javafx.iio

public Interface ImageFormatDescription

Known Direct Implementers
com.sun.javafx.iio.common.ImageDescriptor
Imports
java.util.Arrays, .List

A description of image format attributes.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ImageFormatDescription.Signature

Represents a sequences of bytes which can appear at the beginning of the stream of an image stored in this format.

Method Summary

Modifier and TypeMethod and Description
public List<String>

Returns:

the file extension(s) for this format.
getExtensions
()

Get the extension(s) used for a file stored in this format, preferably in lower case.

public String

Returns:

the format name.
getFormatName
()

Get the name of the format, for example "JPEG," "PNG," and so on, preferably in upper case.

public List<String>

Returns:

the MIME type(s) of this format.
getMIMESubtypes
()

Get the MIME subtype(s) of the "image" type corresponding to this format, for example, "jpeg" "png," etc.

public List<ImageFormatDescription.Signature>

Returns:

the signatures of an image stream in this format.
getSignatures
()

Get the possible signatures which may appear at the beginning of the stream of an image stored in this format.

Method Detail

getExtensionsback to summary
public List<String> getExtensions()

Get the extension(s) used for a file stored in this format, preferably in lower case.

Returns:List<String>

the file extension(s) for this format.

getFormatNameback to summary
public String getFormatName()

Get the name of the format, for example "JPEG," "PNG," and so on, preferably in upper case.

Returns:String

the format name.

getMIMESubtypesback to summary
public List<String> getMIMESubtypes()

Get the MIME subtype(s) of the "image" type corresponding to this format, for example, "jpeg" "png," etc.

Returns:List<String>

the MIME type(s) of this format.

getSignaturesback to summary
public List<ImageFormatDescription.Signature> getSignatures()

Get the possible signatures which may appear at the beginning of the stream of an image stored in this format.

Returns:List<ImageFormatDescription.Signature>

the signatures of an image stream in this format.

com.sun.javafx.iio back to summary

public final Class ImageFormatDescription.Signature

extends Object
Class Inheritance

Represents a sequences of bytes which can appear at the beginning of the stream of an image stored in this format.

Field Summary

Modifier and TypeField and Description
private final byte[]

Constructor Summary

AccessConstructor and Description
public
Signature(final byte... bytes)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
matches(final byte[] streamBytes)

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

bytesback to summary
private final byte[] bytes

Constructor Detail

Signatureback to summary
public Signature(final byte... bytes)

Method Detail

equalsback to summary
public boolean equals(final Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
getLengthback to summary
public int getLength()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
matchesback to summary
public boolean matches(final byte[] streamBytes)