Skip to content

Commit

Permalink
Fix Javadoc errors/warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
rfscholte committed Dec 28, 2018
1 parent 50db603 commit a5f60fd
Show file tree
Hide file tree
Showing 9 changed files with 30 additions and 48 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@
import java.io.ByteArrayInputStream;

/**
* @author Hani Suleiman (hani@formicary.net)
* <p/>
* Date: Oct 20, 2003
* Time: 12:46:01 AM
*/
@Deprecated
public class BytesURLConnection extends URLConnection
Expand Down
10 changes: 4 additions & 6 deletions src/main/java/org/codehaus/classworlds/ClassRealm.java
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,11 @@ STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
import java.util.Enumeration;

/**
* Autonomous sub-portion of a <code>ClassWorld</code>.
* <p/>
* <p/>
* This class most closed maps to the <code>ClassLoader</code>
* <p>Autonomous sub-portion of a <code>ClassWorld</code>.</p>
*
* <p>This class most closed maps to the <code>ClassLoader</code>
* role from Java and in facts can provide a <code>ClassLoader</code>
* view of itself using {@link #getClassLoader}.
* </p>
* view of itself using {@link #getClassLoader}.</p>
*
* @author <a href="mailto:bob@eng.werken.com">bob mcwhirter</a>
* @author <a href="mailto:jason@zenplex.com">Jason van Zyl</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@
import java.net.MalformedURLException;

/**
* Created by IntelliJ IDEA.
*
* @uthor: Andrew Williams
* @since: Nov 25, 2006
*/
@Deprecated
public class ConfiguratorAdapter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ public void addConstituent( URL constituent )
*
* @param constituent class name
* @param b the class definition as a byte[]
* @throws ClassNotFoundException when class couldn't be loaded
*/
public void addConstituent(String constituent,
byte[] b) throws ClassNotFoundException
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,18 @@ public interface ConfigurationHandler
/**
* Define a new realm
* @param realmName the new realm name
* @throws DuplicateRealmException
* @throws DuplicateRealmException when realm with name already exists
*/
void addRealm( String realmName )
throws DuplicateRealmException;

/**
* Add an import specification from a realm
* @param relamName the realm name
* @param realmName the realm name
* @param importSpec the import specification
* @throws NoSuchRealmException
* @throws NoSuchRealmException if realm doesn't exist
*/
void addImportFrom( String relamName, String importSpec )
void addImportFrom( String realmName, String importSpec )
throws NoSuchRealmException;

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,12 @@ public ConfigurationParser( ConfigurationHandler handler, Properties systemPrope

/**
* Parse launcher configuration file and send events to the handler.
*
* @param is the inputstream
* @throws IOException when IOException occurs
* @throws ConfigurationException when ConfigurationException occurs
* @throws DuplicateRealmException when realm already exists
* @throws NoSuchRealmException when realm doesn't exist
*/
public void parse( InputStream is )
throws IOException, ConfigurationException, DuplicateRealmException, NoSuchRealmException
Expand Down Expand Up @@ -315,7 +321,7 @@ else if ( line.startsWith( OPTIONALLY_PREFIX ) )
* a valid path element.
* @throws FileNotFoundException If the line does not represent
* a valid path element in the filesystem.
* @throws ConfigurationException
* @throws ConfigurationException will never occur (thrown for backwards compatibility)
*/
protected void loadGlob( String line,
boolean optionally )
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,15 @@
import org.codehaus.plexus.classworlds.realm.NoSuchRealmException;

/**
* Command-line invokable application launcher.
* <p/>
* <p/>
* This launcher class assists in the creation of classloaders and <code>ClassRealm</code>s
* <p>Command-line invokable application launcher.</p>
*
* <p>This launcher class assists in the creation of classloaders and <code>ClassRealm</code>s
* from a configuration file and the launching of the application's <code>main</code>
* method from the correct class loaded through the correct classloader.
* </p>
* <p/>
* <p/>
* The path to the configuration file is specified using the <code>classworlds.conf</code>
* method from the correct class loaded through the correct classloader.</p>
*
* <p> The path to the configuration file is specified using the <code>classworlds.conf</code>
* system property, typically specified using the <code>-D</code> switch to
* <code>java</code>.
* </p>
* <code>java</code>.</p>
*
* @author <a href="mailto:bob@eng.werken.com">bob mcwhirter</a>
*/
Expand Down Expand Up @@ -239,12 +235,9 @@ public void launch( String[] args )
}

/**
* Attempt to launch the application through the enhanced main method.
* <p/>
* <p/>
* This will seek a method with the exact signature of:
* </p>
* <p/>
* <p>Attempt to launch the application through the enhanced main method.</p>
*
* <p>This will seek a method with the exact signature of:</p>
* <pre>
* public static void main(String[] args, ClassWorld world)
* </pre>
Expand Down Expand Up @@ -297,12 +290,10 @@ protected void launchEnhanced( String[] args )
}

/**
* Attempt to launch the application through the standard main method.
* <p/>
* <p/>
* This will seek a method with the exact signature of:
* </p>
* <p/>
* <p>Attempt to launch the application through the standard main method.</p>
*
* <p>This will seek a method with the exact signature of:</p>
* <pre>
* public static void main(String[] args)
* </pre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,6 @@
/**
* A strategy is a class for defining how classes and resources are located
* in classworlds.
*
* @uthor: Andrew Williams
* @since: Nov 19, 2006
*/
public interface Strategy
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@

/**
* StrategyFactory loads a strategy, either default or from a given hint.
*
* @uthor: Andrew Williams
* @since: Nov 19, 2006
*/
public class StrategyFactory
{
Expand Down

0 comments on commit a5f60fd

Please sign in to comment.