net.morimekta.console

Class FormatString

java.lang.Object

net.morimekta.console.FormatString

All Implemented Interfaces:

org.kohsuke.args4j.Localizable

public class FormatString
extends Object
implements org.kohsuke.args4j.Localizable

Simple non-translated localizable (l10n) formatted string for use with org.kohsuke.args4j.

Constructor Summary

Constructors

Constructor and Description
FormatString(String format) Create a format-string with the given format.
FormatString(String format, Locale locale) Make a format-string with given format for given locale.

Method Summary

Modifier and Type	Method and Description
static org.kohsuke.args4j.CmdLineException	except(org.kohsuke.args4j.CmdLineParser cli, String format, String... args) Convenience method to make an exception that matches the given arguments without translations.
String	format(Object... args)
String	formatWithLocale(Locale locale, Object... args) Formats with specified locale.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatString

public FormatString(String format)

Create a format-string with the given format.

Parameters:

format - The string format.

See Also:

for formatting reference.

FormatString

public FormatString(String format,
                    Locale locale)

Make a format-string with given format for given locale.

Parameters:

format - The string format.

locale - The locale to format it for.

Method Detail

formatWithLocale

public String formatWithLocale(Locale locale,
                               Object... args)

Formats with specified locale.

Specified by:

formatWithLocale in interface org.kohsuke.args4j.Localizable

Parameters:

locale - The locale to format the string with.

args -

Returns:

format

public String format(Object... args)

Specified by:

format in interface org.kohsuke.args4j.Localizable

except

public static org.kohsuke.args4j.CmdLineException except(org.kohsuke.args4j.CmdLineParser cli,
                                                         String format,
                                                         String... args)

Convenience method to make an exception that matches the given arguments without translations.

Parameters:

cli - The CLI parser to reference.

format - The string format.

args - The string arguments.

Returns:

The exception generated.