org.apache.tika.metadata

Enum TikaCoreProperties.EmbeddedResourceType

java.lang.Object

java.lang.Enum<TikaCoreProperties.EmbeddedResourceType>

org.apache.tika.metadata.TikaCoreProperties.EmbeddedResourceType

All Implemented Interfaces:

Serializable, Comparable<TikaCoreProperties.EmbeddedResourceType>

Enclosing interface:

TikaCoreProperties

public static enum TikaCoreProperties.EmbeddedResourceType
extends Enum<TikaCoreProperties.EmbeddedResourceType>

A file might contain different types of embedded documents. The most common is the ATTACHMENT.

An INLINE embedded resource should be used for embedded image files that are used to render the page image (as in PDXObjImages in PDF files).

A MACRO is code that is embedded in the document and is intended to be executable within the application that opens the document. This includes traditional macros within Microsoft Office files and javascript within PDFActions. This would not include, e.g., an .exe file embedded in a .zip file.

A VERSION is an earlier version of the file as in incremental updates. The initial use case for this is incremental updates in PDFs, but it could be applied to other file formats as well where earlier versions are recoverable. See also PDF.INCREMENTAL_UPDATE_NUMBER

Not all parsers have yet implemented this.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALTERNATE_FORMAT_CHUNK
ATTACHMENT
FONT
INLINE
MACRO
METADATA
RENDERING
THUMBNAIL
VERSION

Method Summary

Modifier and Type	Method and Description
static TikaCoreProperties.EmbeddedResourceType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TikaCoreProperties.EmbeddedResourceType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INLINE

public static final TikaCoreProperties.EmbeddedResourceType INLINE

ATTACHMENT

public static final TikaCoreProperties.EmbeddedResourceType ATTACHMENT

MACRO

public static final TikaCoreProperties.EmbeddedResourceType MACRO

METADATA

public static final TikaCoreProperties.EmbeddedResourceType METADATA

FONT

public static final TikaCoreProperties.EmbeddedResourceType FONT

THUMBNAIL

public static final TikaCoreProperties.EmbeddedResourceType THUMBNAIL

RENDERING

public static final TikaCoreProperties.EmbeddedResourceType RENDERING

VERSION

public static final TikaCoreProperties.EmbeddedResourceType VERSION

ALTERNATE_FORMAT_CHUNK

public static final TikaCoreProperties.EmbeddedResourceType ALTERNATE_FORMAT_CHUNK

Method Detail

values

public static TikaCoreProperties.EmbeddedResourceType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TikaCoreProperties.EmbeddedResourceType c : TikaCoreProperties.EmbeddedResourceType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TikaCoreProperties.EmbeddedResourceType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null