net.sf.mmm.util.nls.base

Enum Format

java.lang.Object

java.lang.Enum<Format>

net.sf.mmm.util.nls.base.Format

All Implemented Interfaces:

Serializable, Comparable<Format>

public enum Format
extends Enum<Format>

This Enum defines the available formats of the resource bundle output file to convert to.

Since:

7.3.0

Author:

hohwille

See Also:

ResourceBundleConverter

Enum Constant Summary

Enum Constants

Enum Constant and Description
json Format as JSON.
properties Format as Properties.

Method Summary

Modifier and Type	Method and Description
(package private) abstract String	getNewline()
static Format	valueOf(String name) Returns the enum constant of this type with the specified name.
static Format[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
(package private) void	write(Properties props, File file, String encoding, String comment)
private void	writeEnd(Writer writer)
private void	writeProperty(Writer writer, String key, String message, boolean first)
private void	writeStart(Writer writer, String comment)

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

properties

public static final Format properties

Format as Properties.

json

public static final Format json

Format as JSON.

Method Detail

values

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

Returns:

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

valueOf

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

getNewline

abstract String getNewline()

write

void write(Properties props,
           File file,
           String encoding,
           String comment)

writeProperty

private void writeProperty(Writer writer,
                           String key,
                           String message,
                           boolean first)
                    throws IOException

Throws:

IOException

writeStart

private void writeStart(Writer writer,
                        String comment)
                 throws IOException

Throws:

IOException

writeEnd

private void writeEnd(Writer writer)
               throws IOException

Throws:

IOException