io.github.eb4j

Class Appendix

java.lang.Object

io.github.eb4j.Appendix

public class Appendix
extends java.lang.Object

付録パッケージクラス。

Constructor Summary

Constructors

Constructor and Description
Appendix(java.io.File dir) Initialize new appendix object by looking into File dir of the appendix package.
Appendix(java.lang.String path) Initialize new appendix object indicated by String path.

Method Summary

Modifier and Type	Method and Description
int	getAppendixType() Returns a type of appendix package.
java.lang.String	getPath() Returns an appendix package path.
SubAppendix	getSubAppendix(int index) Returns sub-book object in the appendix package indicated by index.
int	getSubAppendixCount() Returns number of sub books in the appendix package.
SubAppendix[]	getSubAppendixes() Return a list of sub-books in the appendix package.

Methods inherited from class java.lang.Object

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

Constructor Detail

Appendix

public Appendix(java.lang.String path)
         throws EBException

Initialize new appendix object indicated by String path.

Parameters:

path - Path of appendix package in String.

Throws:

EBException - when error on initialization.

Appendix

public Appendix(java.io.File dir)
         throws EBException

Initialize new appendix object by looking into File dir of the appendix package.

Parameters:

dir - Path of appendix package in File

Throws:

EBException - when error on initialization.

Method Detail

getPath

public java.lang.String getPath()

Returns an appendix package path.

Returns:

String in an appendix package path.

getAppendixType

public int getAppendixType()

Returns a type of appendix package.

Returns:

flag to indicate type of appendix package

See Also:

Book.DISC_EB, Book.DISC_EPWING

getSubAppendixCount

public int getSubAppendixCount()

Returns number of sub books in the appendix package.

Returns:

a number of sub books

getSubAppendixes

public SubAppendix[] getSubAppendixes()

Return a list of sub-books in the appendix package.

Returns:

array of sub-books

getSubAppendix

public SubAppendix getSubAppendix(int index)

Returns sub-book object in the appendix package indicated by index.

Parameters:

index - an index in the sub-books list.

Returns:

SubAppendix object that is sub-book of appendix package. null when index is out of bound.