eu.simuline.m2latex.core

Enum Target

java.lang.Object

java.lang.Enum<Target>

eu.simuline.m2latex.core.Target

All Implemented Interfaces:

Serializable, Comparable<Target>

public enum Target
extends Enum<Target>

The enumeration of all supported creational targets. Additional targets are clr and grp. The latter is not creational. Created: Fri Oct 7 13:32:21 2016

Version:

1.0

Author:

Ernst Reissner

Enum Constant Summary

Enum Constants

Enum Constant and Description
docx Based on odt
dvi standalone.
html Based on pdf
odt Based on pdf
pdf standalone.
rtf standalone
txt Based on pdf

Method Summary

Modifier and Type	Method and Description
abstract String	getPatternOutputFiles(Settings settings) Returns the pattern of the output files.
abstract void	processSource(LatexProcessor latexProcessor, File texFile) Processes the latex main file texFile delegating to latexProcessor.
static Target	valueOf(String name) Returns the enum constant of this type with the specified name.
static Target[]	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

rtf

public static final Target rtf

standalone

dvi

public static final Target dvi

standalone.

pdf

public static final Target pdf

standalone.

html

public static final Target html

Based on pdf

odt

public static final Target odt

Based on pdf

docx

public static final Target docx

Based on odt

txt

public static final Target txt

Based on pdf

Method Detail

values

public static Target[] 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 (Target c : Target.values())
    System.out.println(c);

Returns:

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

valueOf

public static Target 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

processSource

public abstract void processSource(LatexProcessor latexProcessor,
                                   File texFile)
                            throws BuildFailureException

Processes the latex main file texFile delegating to latexProcessor. Logging: FIXME: may be incomplete

• EEX01, EEX02, EEX03, WEX04, WEX05 if running a command to transform texFile failed.

Parameters:

latexProcessor - the processor to process texFile

texFile - the latex main file to be processed.

Throws:

BuildFailureException - TEX01 if invocation of a command to transform texFile failed.

getPatternOutputFiles

public abstract String getPatternOutputFiles(Settings settings)

Returns the pattern of the output files. For example if creating pdf, this is just ^T$T\.pdf$, where T$T represents the name of the latex main file without suffix. For target html, this is much more complicated, because a lot of files are created in general, not only ^T$T\.h?tml?$.

Parameters:

settings - the settings required to determine the pattern. This depends on the settings for html only.