Thread: [Japi-cvs] SF.net SVN: japi:[1216] libs/argparser/trunk/src/prj/net/sf/japi/io/args
Status: Beta
Brought to you by:
christianhujer
Menu
▾
▴
japi-cvs
|
From: <chr...@us...> - 2009-03-02 01:16:52
|
Revision: 1216
http://japi.svn.sourceforge.net/japi/?rev=1216&view=rev
Author: christianhujer
Date: 2009-03-02 01:16:50 +0000 (Mon, 02 Mar 2009)
Log Message:
-----------
Add @since information for classes and packages.
Modified Paths:
--------------
libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgParser.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgumentFileNotFoundException.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/BasicCommand.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/CharsetDisplaynameComparator.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/Command.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/CommandWithHelp.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/LogCommand.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/MethodOptionComparator.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/MissingArgumentException.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/Obsolete.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/OptionType.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/RequiredOptionsMissingException.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/StringJoiner.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/TerminalException.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/TokenReader.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/UnknownOptionException.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/AbstractConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/BooleanConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ByteConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/CharConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConstructorConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/Converter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConverterRegistry.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/DoubleConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/EnumConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/FloatConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/InputStreamConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/IntegerConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/LogLevelConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/LongConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/NoConverterFoundException.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/OutputStreamConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ShortConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/StringConverter.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/package-info.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/package-info.java
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgParser.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgParser.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgParser.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -40,6 +40,7 @@
* Parser for command line arguments.
*
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*
* @todo better handling of boolean arguments
* @todo Handling of - for STDIN as input argument filestream
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgumentFileNotFoundException.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgumentFileNotFoundException.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgumentFileNotFoundException.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -24,6 +24,7 @@
/** This type of exception is thrown when an argument file was not found.
* Created by IntelliJ IDEA.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class ArgumentFileNotFoundException extends FileNotFoundException {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/BasicCommand.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/BasicCommand.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/BasicCommand.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -23,6 +23,7 @@
/**
* BasicCommand is a base class for commands that provides the options --help, --exit and --noexit.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public abstract class BasicCommand extends CommandWithHelp {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/CharsetDisplaynameComparator.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/CharsetDisplaynameComparator.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/CharsetDisplaynameComparator.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -27,6 +27,7 @@
/** Comparator that compares Charsets by their displayName.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
* @todo move to a different library / package.
*/
public class CharsetDisplaynameComparator implements Comparator<Charset>, Serializable {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/Command.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/Command.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/Command.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -24,6 +24,7 @@
/**
* Shell commands can implement this interface and make use of ArgParser.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
* @see BasicCommand BasicCommand for a very convenient implementation of this interface
*/
public interface Command {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/CommandWithHelp.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/CommandWithHelp.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/CommandWithHelp.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -34,6 +34,7 @@
* If you're looking for the best gui command base class, this probably is suited for you.
* If you're looking for the best cmd command base class, better go for {@link BasicCommand}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public abstract class CommandWithHelp implements Command {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/LogCommand.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/LogCommand.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/LogCommand.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -30,6 +30,7 @@
/**
* Subclass of BasicCommand that provides logging through {@link java.util.logging}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public abstract class LogCommand extends BasicCommand {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/MethodOptionComparator.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/MethodOptionComparator.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/MethodOptionComparator.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -26,6 +26,7 @@
/** Compares methods by their options.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class MethodOptionComparator implements Comparator<Method>, Serializable {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/MissingArgumentException.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/MissingArgumentException.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/MissingArgumentException.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -23,6 +23,7 @@
/**
* This exception is thrown in case a required argument for an option is missing.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class MissingArgumentException extends Exception {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/Obsolete.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/Obsolete.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/Obsolete.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -30,6 +30,7 @@
* The methods of obsolete options may perform no action.
* The argument parser will take care of warning the user about the usage of an obsolete option.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
* @todo eventually make this an attribute of {@link Option} instead.
*/
@Documented
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -27,6 +27,7 @@
/**
* Annotation to mark a method as command argument method.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
@Documented
@Retention(RUNTIME)
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/OptionType.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/OptionType.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/OptionType.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -26,6 +26,7 @@
/**
* The type of an {@link Option}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public enum OptionType {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/RequiredOptionsMissingException.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/RequiredOptionsMissingException.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/RequiredOptionsMissingException.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -23,6 +23,7 @@
/**
* This exception is thrown in case required options are missing.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class RequiredOptionsMissingException extends Exception {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/StringJoiner.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/StringJoiner.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/StringJoiner.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -30,6 +30,7 @@
* Because {@link Appendable#append(CharSequence)} throws {@link IOException}, methods that work on {@link Appendable} have been overloaded to work on certain known {@link Appendable}-implementations that do not throw an {@link IOException} when appending.
* Currently this is namely {@link StringBuilder} and {@link StringBuffer}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public final class StringJoiner {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/TerminalException.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/TerminalException.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/TerminalException.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -21,6 +21,7 @@
/**
* This exception is thrown when an argument method is terminal, i.e. stops further command processing.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class TerminalException extends Exception {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/TokenReader.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/TokenReader.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/TokenReader.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -38,6 +38,7 @@
* <li>' introduces a literal string. A literal string is ended with '. Inside a literal string, only ' has special meaning.</li>
* </ul>
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class TokenReader implements Closeable, Iterable<String>, Iterator<String> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/UnknownOptionException.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/UnknownOptionException.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/UnknownOptionException.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -23,6 +23,7 @@
/**
* This exception is thrown in case one or more unknown options were encountered.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class UnknownOptionException extends Exception {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/AbstractConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/AbstractConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/AbstractConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -26,6 +26,7 @@
* Base class for the default converters.
* @param <T> target type to convert to.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public abstract class AbstractConverter<T> implements Converter<T> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/BooleanConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/BooleanConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/BooleanConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -25,6 +25,7 @@
/**
* Common Superclass for converters that convert to Boolean or boolean.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class BooleanConverter extends AbstractConverter<Boolean> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ByteConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ByteConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ByteConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -27,6 +27,7 @@
* That means the following formats are supported:
* @note This converter always behaves the same independently of the {@link Locale}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
* @see Byte#decode(String) Minimum grammar supported.
*/
public class ByteConverter extends AbstractConverter<Byte> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/CharConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/CharConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/CharConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -27,6 +27,7 @@
* That means the following formats are supported:
* @note This converter always behaves the same independently of the {@link Locale}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
* @see String#charAt(int) Minimum grammar supported.
*/
public class CharConverter extends AbstractConverter<Character> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConstructorConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConstructorConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConstructorConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -26,6 +26,7 @@
* Converter that performs a conversion by
* @param <T> target type to convert to.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class ConstructorConverter<T> extends AbstractConverter<T> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/Converter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/Converter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/Converter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -25,6 +25,7 @@
* The Converter interface is used for converters that convert Strings into other types.
* @param <T> target type to convert to.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public interface Converter<T> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConverterRegistry.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConverterRegistry.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConverterRegistry.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -29,6 +29,7 @@
/**
* Registry for Converters.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class ConverterRegistry {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/DoubleConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/DoubleConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/DoubleConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -27,6 +27,7 @@
* That means the following formats are supported:
* @note This converter always behaves the same independently of the {@link Locale}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
* @see Double#valueOf(String) Minimum grammar supported.
*/
public class DoubleConverter extends AbstractConverter<Double> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/EnumConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/EnumConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/EnumConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -24,6 +24,7 @@
/** Generic converter for Enum classes.
* @param <T> target type to convert to.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class EnumConverter<T extends Enum> extends AbstractConverter<T> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/FloatConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/FloatConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/FloatConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -27,6 +27,7 @@
* That means the following formats are supported:
* @note This converter always behaves the same independently of the {@link Locale}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
* @see Float#valueOf(String) Minimum grammar supported.
*/
public class FloatConverter extends AbstractConverter<Float> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/InputStreamConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/InputStreamConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/InputStreamConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -30,6 +30,7 @@
* Converter that converts a String into an InputStream.
* @note This converter always behaves the same independently of the {@link Locale}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
* @deprecated The concept of this class is not yet mature. Please don't use it.
*/
@Deprecated public class InputStreamConverter extends AbstractConverter<InputStream> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/IntegerConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/IntegerConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/IntegerConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -27,6 +27,7 @@
* That means the following formats are supported:
* @note This converter always behaves the same independently of the {@link Locale}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
* @see Integer#decode(String) Minimum grammar supported.
*/
public class IntegerConverter extends AbstractConverter<Integer> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/LogLevelConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/LogLevelConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/LogLevelConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -26,6 +26,7 @@
* Created by IntelliJ IDEA.
*
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class LogLevelConverter extends AbstractConverter<Level> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/LongConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/LongConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/LongConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -27,6 +27,7 @@
* That means the following formats are supported:
* @note This converter always behaves the same independently of the {@link Locale}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
* @see Long#decode(String) Minimum grammar supported.
*/
public class LongConverter extends AbstractConverter<Long> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/NoConverterFoundException.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/NoConverterFoundException.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/NoConverterFoundException.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -21,6 +21,7 @@
/**
* Exception that is thrown in case no matching converter for a conversion was found.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class NoConverterFoundException extends Exception {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/OutputStreamConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/OutputStreamConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/OutputStreamConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -29,6 +29,7 @@
* Converter that converts a String into an InputStream.
* @note This converter always behaves the same independently of the {@link Locale}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
* @deprecated The concept of this class is not yet mature. Please don't use it.
*/
@Deprecated public class OutputStreamConverter extends AbstractConverter<OutputStream> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ShortConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ShortConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ShortConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -27,6 +27,7 @@
* That means the following formats are supported:
* @note This converter always behaves the same independently of the {@link Locale}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
* @see Short#decode(String) Minimum grammar supported.
*/
public class ShortConverter extends AbstractConverter<Short> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/StringConverter.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/StringConverter.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/StringConverter.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -26,6 +26,7 @@
* It exists to be able to apply the same conversion pattern for all types including Strings.
* @note This converter always behaves the same independently of the {@link Locale}.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
public class StringConverter extends AbstractConverter<String> {
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/package-info.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/package-info.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/package-info.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -21,5 +21,6 @@
* For instance, a Command might simply want to read bytes from an InputStream.
* The Converter package will convert the String into an InputStream then.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
package net.sf.japi.io.args.converter;
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/package-info.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/package-info.java 2009-03-02 01:15:38 UTC (rev 1215)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/package-info.java 2009-03-02 01:16:50 UTC (rev 1216)
@@ -59,5 +59,6 @@
* </ul>
*
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.2
*/
package net.sf.japi.io.args;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <chr...@us...> - 2009-05-09 22:14:28
|
Revision: 1280
http://japi.svn.sourceforge.net/japi/?rev=1280&view=rev
Author: christianhujer
Date: 2009-05-09 22:14:21 +0000 (Sat, 09 May 2009)
Log Message:
-----------
Documentation improvements.
Modified Paths:
--------------
libs/argparser/trunk/src/prj/net/sf/japi/io/args/MethodOptionComparator.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/TokenReader.java
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/MethodOptionComparator.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/MethodOptionComparator.java 2009-05-09 22:13:29 UTC (rev 1279)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/MethodOptionComparator.java 2009-05-09 22:14:21 UTC (rev 1280)
@@ -24,7 +24,7 @@
import java.util.Comparator;
import org.jetbrains.annotations.NotNull;
-/** Compares methods by their options.
+/** Compares methods by their {@link Option}s.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
* @since 0.2
*/
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java 2009-05-09 22:13:29 UTC (rev 1279)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java 2009-05-09 22:14:21 UTC (rev 1280)
@@ -61,6 +61,7 @@
* Default is <code>""</code> (empty String) which is interpreted as the associated method's name being the key.
* @return option key
*/
+ // Cannot be null instead of "" because null is not interpreted as a constant here.
String key() default "";
} // @interface Option
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/TokenReader.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/TokenReader.java 2009-05-09 22:13:29 UTC (rev 1279)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/TokenReader.java 2009-05-09 22:14:21 UTC (rev 1280)
@@ -183,7 +183,7 @@
/** String Escape - \ inside "". */
STRING_ESCAPE,
- /** Secape - after \ but outside "". */
+ /** Escape - after \ but outside "". */
ESCAPE,
/** String - inside ''. */
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <chr...@us...> - 2009-05-23 19:16:13
|
Revision: 1331
http://japi.svn.sourceforge.net/japi/?rev=1331&view=rev
Author: christianhujer
Date: 2009-05-23 19:16:12 +0000 (Sat, 23 May 2009)
Log Message:
-----------
Fix bugs found by findbugs.
Modified Paths:
--------------
libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgParser.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/CharsetDisplaynameComparator.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConverterRegistry.java
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgParser.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgParser.java 2009-05-23 16:38:35 UTC (rev 1330)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgParser.java 2009-05-23 19:16:12 UTC (rev 1331)
@@ -82,6 +82,7 @@
* @throws UnknownOptionException In case an option was specified that's not supported.
* @throws ArgumentFileNotFoundException in case an argument file was not found.
*/
+ @edu.umd.cs.findbugs.annotations.SuppressWarnings("DM_EXIT")
private ArgParser(@NotNull final Command command, @NotNull final String... args) throws TerminalException, RequiredOptionsMissingException, UnknownOptionException, MissingArgumentException, ArgumentFileNotFoundException {
this.command = command;
commandClass = command.getClass();
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/CharsetDisplaynameComparator.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/CharsetDisplaynameComparator.java 2009-05-23 16:38:35 UTC (rev 1330)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/CharsetDisplaynameComparator.java 2009-05-23 19:16:12 UTC (rev 1331)
@@ -22,6 +22,8 @@
import java.util.Comparator;
import java.util.Locale;
import java.text.Collator;
+import java.io.IOException;
+import java.io.ObjectInputStream;
import java.io.Serializable;
import org.jetbrains.annotations.NotNull;
@@ -46,7 +48,7 @@
/** The Collator to use for comparing the display name.
* @serial include
*/
- @NotNull private final Collator collator;
+ @NotNull private transient Collator collator;
/** Create a CharsetDisplaynameComparator based on the default locale.
* The default locale is queried when the CharsetDisplaynameComparator is created.
@@ -68,4 +70,10 @@
public int compare(@NotNull final Charset o1, @NotNull final Charset o2) {
return collator.compare(o1.displayName(locale), o2.displayName(locale));
}
+
+ /** {@inheritDoc} */
+ private void readObject(@NotNull final ObjectInputStream in) throws ClassNotFoundException, IOException {
+ in.defaultReadObject();
+ collator = Collator.getInstance(locale);
+ }
}
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConverterRegistry.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConverterRegistry.java 2009-05-23 16:38:35 UTC (rev 1330)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConverterRegistry.java 2009-05-23 19:16:12 UTC (rev 1331)
@@ -97,11 +97,8 @@
*/
@Nullable public <T> Converter<T> getConverter(@NotNull final Class<T> clazz) {
//noinspection unchecked
- @Nullable Converter<T> converter = null;
+ @Nullable Converter<T> converter = (Converter<T>) converters.get(clazz);
if (converter == null) {
- converter = (Converter<T>) converters.get(clazz);
- }
- if (converter == null) {
converter = getConstructorConverter(clazz);
}
if (converter == null && Enum.class.isAssignableFrom(clazz)) {
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <chr...@us...> - 2009-10-26 05:54:41
|
Revision: 1392
http://japi.svn.sourceforge.net/japi/?rev=1392&view=rev
Author: christianhujer
Date: 2009-10-26 05:54:27 +0000 (Mon, 26 Oct 2009)
Log Message:
-----------
Improve documentation.
Modified Paths:
--------------
libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgParser.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java
libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConverterRegistry.java
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgParser.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgParser.java 2009-10-05 23:51:41 UTC (rev 1391)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/ArgParser.java 2009-10-26 05:54:27 UTC (rev 1392)
@@ -38,10 +38,26 @@
/**
* Parser for command line arguments.
+ * <p>
+ * The most popular usage is by extending {@link BasicCommand} and invoking {@link #simpleParseAndRun(Command, String[])}, like this:
+ * {@listing java import net.sf.japi.io.args.*;
+ * public class HelloCommand extends BasicCommand {
+ * public static void main(final String... args) {
+ * ArgParser.simpleParseAndRun(new HelloCommand(), args);
+ * }
+ * public void run(final List<String> args) throws Exception {
+ * System.out.println("Hello, world!");
+ * }
+ * }}
*
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
* @since 0.2
*
+ * @see net.sf.japi.io.args
+ * @see Command
+ * @see BasicCommand
+ * @see ConverterRegistry
+ *
* @todo better handling of boolean arguments
* @todo Handling of - for STDIN as input argument filestream
* @todo automatic printout of default values if property getter available.
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java 2009-10-05 23:51:41 UTC (rev 1391)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java 2009-10-26 05:54:27 UTC (rev 1392)
@@ -26,8 +26,36 @@
/**
* Annotation to mark a method as command argument method.
+ * <p>
+ * Examples:
+ * {@listing java @Option("r")
+ * public void recurse() {
+ * recursive = true;
+ * }
+ *
+ * @Option("recursive")
+ * public void setRecursive(final boolean recursive) {
+ * this.recursive = recursive;
+ * }
+ *
+ * @Option(type = OptionType.TERMINAL, value = {"listEncodings"})
+ * public void listEncodings() {
+ * for (final String encoding : encodings) {
+ * System.out.println(encoding);
+ * }
+ * }
+ * }
+ * The commands derived from {@link CommandWithHelp} (incl. {@link BasicCommand}) support reading help descriptions from {@link ResourceBundle}s.
+ * For that, the package of the command implementation needs a {Resourcebundle} with the same basename as the command class.
+ * A properties file which matches above example could look like this:
+ * {@listing properties recurse=Recurse into subdirectories.
+ * setRecursive=Set whether or not to recurse into subdirectories.
+ * listEncodings=List the encodings and exit.}
+ *
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
* @since 0.2
+ *
+ * @see OptionType for the supported types of options.
*/
@Documented
@Retention(RUNTIME)
Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConverterRegistry.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConverterRegistry.java 2009-10-05 23:51:41 UTC (rev 1391)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/converter/ConverterRegistry.java 2009-10-26 05:54:27 UTC (rev 1392)
@@ -27,9 +27,9 @@
import org.jetbrains.annotations.Nullable;
/**
- * Registry for Converters.
+ * Registry for {@link Converter}s.
* <p>
- * Per default, the following are supported:
+ * Per default, the following {@link Converter}s are supported:
* <ul>
* <li>String (this is an identity conversion)</li>
* <li>All primitive types (boolean, byte, short, int, long, char, float, double).</li>
@@ -37,6 +37,7 @@
* <li>All types which have a public constructor that takes a single String argument.</li>
* <li>All Enums.</li>
* </ul>
+ * The ConverterRegistry uses the {@link ServiceLoader ServiceLoader} to find additional {@link Converter}s.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
* @since 0.2
*/
@@ -128,6 +129,7 @@
*/
public <T> void register(@NotNull final Converter<T> converter) {
converters.put(converter.getTargetClass(), converter);
+ //noinspection NestedAssignment
for (Class<?> superClass = converter.getTargetClass(); (superClass = superClass.getSuperclass()) != null;) {
if (!converters.containsKey(superClass)) {
converters.put(superClass, converter);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X