org.apache.maven.doxia.wrapper
Class OutputFileWrapper

java.lang.Object
  org.apache.maven.doxia.wrapper.OutputFileWrapper

All Implemented Interfaces:

Serializable

public class OutputFileWrapper
extends Object

Wrapper for an output file.

Version:

$Id: OutputFileWrapper.java 712860 2008-11-10 22:54:37Z hboutemy $

Author:

Vincent Siveton

See Also:

Serialized Form

Field Summary

static String	AUTO_ENCODING
static String	AUTO_FORMAT

Method Summary

boolean	equals(Object other)
String	getEncoding()
File	getFile()
String	getFormat()
String[]	getSupportedFormat()
int	hashCode()
String	toString()
static OutputFileWrapper	valueOf(String absolutePath, String format, String[] supportedFormat)
static OutputFileWrapper	valueOf(String absolutePath, String format, String charsetName, String[] supportedFormat)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

AUTO_ENCODING

public static final String AUTO_ENCODING

See Also:

Constant Field Values

AUTO_FORMAT

public static final String AUTO_FORMAT

See Also:

Constant Field Values

Method Detail

valueOf

public static OutputFileWrapper valueOf(String absolutePath,
                                        String format,
                                        String[] supportedFormat)
                                 throws IllegalArgumentException,
                                        UnsupportedEncodingException

Parameters:

absolutePath - not null

format - not null

supportedFormat - not null

Returns:

a type safe output writer

Throws:

IllegalArgumentException - if any.

UnsupportedEncodingException - if the encoding is unsupported.

valueOf

public static OutputFileWrapper valueOf(String absolutePath,
                                        String format,
                                        String charsetName,
                                        String[] supportedFormat)
                                 throws IllegalArgumentException,
                                        UnsupportedEncodingException

Parameters:

absolutePath - not null

format - not null

charsetName - could be null

supportedFormat - not null

Returns:

a type safe output writer

Throws:

IllegalArgumentException - if any.

UnsupportedEncodingException - if the encoding is unsupported.

getFile

public File getFile()

Returns:

the file

getEncoding

public String getEncoding()

Returns:

the encoding used for the file or null if not specified.

equals

public boolean equals(Object other)

hashCode

public int hashCode()

toString

public String toString()

getFormat

public String getFormat()

Returns:

the wanted format.

getSupportedFormat

public String[] getSupportedFormat()

Returns:

the supportedFormat