org.apache.tika.parser.microsoft.chm

Class DirectoryListingEntry

java.lang.Object

org.apache.tika.parser.microsoft.chm.DirectoryListingEntry

public class DirectoryListingEntry
extends Object

The format of a directory listing entry is as follows: BYTE: length of name BYTEs: name (UTF-8 encoded) ENCINT: content section ENCINT: offset ENCINT: length The offset is from the beginning of the content section the file is in, after the section has been decompressed (if appropriate). The length also refers to length of the file in the section after decompression. There are two kinds of file represented in the directory: user data and format related files. The files which are format-related have names which begin with '::', the user data files have names which begin with "/".

Constructor Summary

Constructors

Constructor and Description
DirectoryListingEntry()
DirectoryListingEntry(int name_length, String name, ChmCommons.EntryType isCompressed, int offset, int length) Constructs directoryListingEntry

Method Summary

Modifier and Type	Method and Description
ChmCommons.EntryType	getEntryType() Returns ChmCommons.EntryType (COMPRESSED or UNCOMPRESSED)
int	getLength()
String	getName() Returns an entry name
int	getNameLength() Returns an entry name length
int	getOffset()
protected void	setEntryType(ChmCommons.EntryType entryType)
protected void	setLength(int length)
protected void	setName(String name) Sets entry name
protected void	setNameLength(int name_length) Sets an entry name length
protected void	setOffset(int offset)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DirectoryListingEntry

public DirectoryListingEntry()

DirectoryListingEntry

public DirectoryListingEntry(int name_length,
                             String name,
                             ChmCommons.EntryType isCompressed,
                             int offset,
                             int length)
                      throws TikaException

Constructs directoryListingEntry

Parameters:

name_length - int

name - String

isCompressed - ChmCommons.EntryType

offset - int

length - int

Throws:

TikaException

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getNameLength

public int getNameLength()

Returns an entry name length

Returns:

int

setNameLength

protected void setNameLength(int name_length)

Sets an entry name length

Parameters:

name_length - int

getName

public String getName()

Returns an entry name

Returns:

String

setName

protected void setName(String name)

Sets entry name

Parameters:

name - String

getEntryType

public ChmCommons.EntryType getEntryType()

Returns ChmCommons.EntryType (COMPRESSED or UNCOMPRESSED)

Returns:

ChmCommons.EntryType

setEntryType

protected void setEntryType(ChmCommons.EntryType entryType)

getOffset

public int getOffset()

setOffset

protected void setOffset(int offset)

getLength

public int getLength()

setLength

protected void setLength(int length)