com.martiansoftware.jsap.stringparsers.PackageStringParser Maven / Gradle / Ivy
Show all versions of jsap Show documentation
/*
* Copyright (c) 2002-2004, Martian Software, Inc.
* This file is made available under the LGPL as described in the accompanying
* LICENSE.TXT file.
*/
package com.martiansoftware.jsap.stringparsers;
import com.martiansoftware.jsap.StringParser;
import com.martiansoftware.jsap.ParseException;
/**
* A {@link com.martiansoftware.jsap.StringParser} for parsing Packages. The parse() method delegates the actual
* parsing to Package.getPackage(String), and returns the resulting
* Package object.
* If Package.getPackage() returns null, a ParseException is
* thrown.
* @author Marty Lamb
* @see com.martiansoftware.jsap.StringParser
* @see java.lang.Package
*/
public class PackageStringParser extends StringParser {
private static final PackageStringParser INSTANCE = new PackageStringParser();
/** Returns a {@link PackageStringParser}.
*
* Convenient access to the only instance returned by
* this method is available through
* {@link com.martiansoftware.jsap.JSAP#PACKAGE_PARSER}.
*
* @return a {@link PackageStringParser}.
*/
public static PackageStringParser getParser() {
return INSTANCE;
}
/**
* Creates a new PackageStringParser
* @deprecated Use {@link #getParser()} or, even better, {@link com.martiansoftware.jsap.JSAP#PACKAGE_PARSER}.
*/
public PackageStringParser() {
super();
}
/**
* Parses the specified argument into a Package object. This method
* delegates the
* parsing to Package.getPackage(String), and returns the
* resulting Package object.
* If Package.getPackage() returns null, a ParseException is
* thrown.
*
* @param arg the argument to parse
* @return a Package object representing the specified package.
* @throws ParseException if Package.getPackage(arg) returns
* null.
* @see java.lang.Package
* @see com.martiansoftware.jsap.StringParser#parse(String)
*/
public Object parse(String arg) throws ParseException {
Package result = Package.getPackage(arg);
if (result == null) {
throw (
new ParseException("Unable to locate Package '" + arg + "'."));
}
return (result);
}
}