net.sf.okapi.filters.doxygen

Class DoxygenFilter

java.lang.Object

net.sf.okapi.common.filters.AbstractFilter

net.sf.okapi.filters.doxygen.DoxygenFilter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter

public class DoxygenFilter
extends AbstractFilter

IFilter for a Doxygen-commented text file

Author:

Aaron Madlon-Kay

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOXYGEN_MIME_TYPE
static String	NUMLINES_PROPERTY

Fields inherited from interface net.sf.okapi.common.filters.IFilter

SUB_FILTER

Constructor Summary

Constructors

Constructor and Description
DoxygenFilter()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the input document.
IFilterWriter	createFilterWriter() Creates a new IFilterWriter object from the most appropriate class to use with this filter.
EncoderManager	getEncoderManager() Gets the EncoderManager object for this filter.
Parameters	getParameters() Gets the current parameters for this filter.
boolean	hasNext() Indicates if there is an event to process.
protected boolean	isUtf8Bom() Does the input have a UTF-8 Byte Order Mark?
protected boolean	isUtf8Encoding() Is the input encoded as UTF-8?
Event	next() Gets the next event available.
void	open(RawDocument input) Opens the input document described in a give RawDocument object.
void	open(RawDocument input, boolean generateSkeleton) Opens the input document described in a give RawDocument object, and optionally creates skeleton information.
void	setParameters(IParameters params) Sets new parameters for this filter.

Methods inherited from class net.sf.okapi.common.filters.AbstractFilter

addConfiguration, addConfiguration, addConfiguration, addConfigurations, cancel, createEndFilterEvent, createSkeletonWriter, createStartFilterEvent, findConfiguration, getConfiguration, getConfigurations, getDisplayName, getDocumentId, getDocumentName, getEncoding, getFilterConfigurationMapper, getFilterWriter, getMimeType, getName, getNewlineType, getParameters, getParametersClassName, getParentId, getSrcLoc, getTrgLoc, isCanceled, isGenerateSkeleton, isMultilingual, removeConfiguration, setDisplayName, setDocumentName, setEncoding, setFilterConfigurationMapper, setFilterWriter, setGenerateSkeleton, setMimeType, setMultilingual, setName, setNewlineType, setOptions, setParentId, setSrcLoc, setTrgLoc

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.okapi.common.filters.IFilter

stream

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

DOXYGEN_MIME_TYPE

public static final String DOXYGEN_MIME_TYPE

See Also:

Constant Field Values

NUMLINES_PROPERTY

public static final String NUMLINES_PROPERTY

See Also:

Constant Field Values

Constructor Detail

DoxygenFilter

public DoxygenFilter()

Method Detail

createFilterWriter

public IFilterWriter createFilterWriter()

Description copied from interface: IFilter

Creates a new IFilterWriter object from the most appropriate class to use with this filter.

Specified by:

createFilterWriter in interface IFilter

Overrides:

createFilterWriter in class AbstractFilter

Returns:

A new instance of IFilterWriter for the preferred implementation for this filter.

open

public void open(RawDocument input)

Description copied from interface: IFilter

Opens the input document described in a give RawDocument object. Skeleton information is always created when you use this method.

Parameters:

input - The RawDocument object to use to open the document.

open

public void open(RawDocument input,
                 boolean generateSkeleton)

Description copied from interface: IFilter

Opens the input document described in a give RawDocument object, and optionally creates skeleton information.

Specified by:

open in interface IFilter

Overrides:

open in class AbstractFilter

Parameters:

input - The RawDocument object to use to open the document.

generateSkeleton - true to generate the skeleton data, false otherwise.

close

public void close()

Description copied from interface: IFilter

Closes the input document. Developers should call this method from within their code before sending the last event: This can allow writer objects to overwrite the input file when they receive the last event. This method must also be safe to call even if the input document is not opened.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IFilter

Overrides:

close in class AbstractFilter

getEncoderManager

public EncoderManager getEncoderManager()

Description copied from interface: IFilter

Gets the EncoderManager object for this filter. This encoder manager should provided the mappings to the different MIME types used by the filter.

Specified by:

getEncoderManager in interface IFilter

Overrides:

getEncoderManager in class AbstractFilter

Returns:

the EncoderManager for this filter.

getParameters

public Parameters getParameters()

Description copied from interface: IFilter

Gets the current parameters for this filter.

Specified by:

getParameters in interface IFilter

Overrides:

getParameters in class AbstractFilter

Returns:

The current parameters for this filter, or null if this filter has no parameters.

setParameters

public void setParameters(IParameters params)

Description copied from interface: IFilter

Sets new parameters for this filter.

Specified by:

setParameters in interface IFilter

Overrides:

setParameters in class AbstractFilter

Parameters:

params - The new parameters to use.

hasNext

public boolean hasNext()

Description copied from interface: IFilter

Indicates if there is an event to process.

Implementer Note: The caller must be able to call this method several times without changing state.

Returns:

True if there is at least one event to process, false if not.

next

public Event next()

Description copied from interface: IFilter

Gets the next event available. Calling this method can be done only once on each event.

Returns:

The next event available or null if there are no events.

isUtf8Bom

protected boolean isUtf8Bom()

Description copied from class: AbstractFilter

Does the input have a UTF-8 Byte Order Mark?

Overrides:

isUtf8Bom in class AbstractFilter

Returns:

true if the document has a utf-8 byte order mark.

isUtf8Encoding

protected boolean isUtf8Encoding()

Description copied from class: AbstractFilter

Is the input encoded as UTF-8?

Overrides:

isUtf8Encoding in class AbstractFilter

Returns:

true if the document is in utf8 encoding.