com.github.aliteralmind.codelet.util

Class FQClassNameWithBaseDir

java.lang.Object

com.github.aliteralmind.codelet.util.FQClassNameWithBaseDir

All Implemented Interfaces:

Copyable

Direct Known Subclasses:

JavaClassWithBaseDir

public class FQClassNameWithBaseDir
extends Object
implements Copyable

Given a base directory and fully-qualified class name, get a Path, LineIterator, or PrintWriter to its source code, class file, or JavaDoc html file. The fully-qualified class name may or may not represent an actually-existing class (as determined by Class.forName(s)).

Since:

0.1.0

Author:

Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com), dual-licensed under the LGPL (version 3.0 or later) or the ASL (version 2.0). See source code for details. http://codelet.aliteralmind.com, https://github.com/aliteralmind/codelet

Constructor Summary

Constructors

Constructor and Description
FQClassNameWithBaseDir(FQClassNameWithBaseDir to_copy) Create a new instance as a duplicate of another.
FQClassNameWithBaseDir(FQClassNameWithBaseDir to_copy, String baseDir_override, String fqClsName_override, String dotXtnsn_override) Create a new instance as a duplicate of another.
FQClassNameWithBaseDir(String base_dir, String fq_className, String dot_plusExtension)

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	appendText(StringBuilder to_appendTo)
String	getBaseDirectory()
String	getClassName()
String	getDotPlusExtension()
String	getFileText()
FQClassNameWithBaseDir	getObjectCopy() Get a duplicate of this FQClassNameWithBaseDir.
Path	getPath()
FQClassNameWithBaseDir	getThisOrCrashIfBad(Existence existence_is, Readable readable_is, Writable writable_is)
FQClassNameWithBaseDir	getThisOrCrashIfBad(Readable readable_is, Writable writable_is)
PrintWriter	newFileWriter()
static PrintWriter	newFileWriterForWriteable(String base_dir, String fq_className, String dot_plusExtension)
Iterator<String>	newLineIterator()
static Iterator<String>	newLineIteratorForExistingReadable(String base_dir, String fq_className, String dot_plusExtension)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FQClassNameWithBaseDir

public FQClassNameWithBaseDir(String base_dir,
                      String fq_className,
                      String dot_plusExtension)

FQClassNameWithBaseDir

public FQClassNameWithBaseDir(FQClassNameWithBaseDir to_copy)

Create a new instance as a duplicate of another.

Parameters:

to_copy - May not be null.

See Also:

getObjectCopy()

FQClassNameWithBaseDir

public FQClassNameWithBaseDir(FQClassNameWithBaseDir to_copy,
                      String baseDir_override,
                      String fqClsName_override,
                      String dotXtnsn_override)

Create a new instance as a duplicate of another.

Parameters:

to_copy - May not be null.

See Also:

getObjectCopy()

Method Detail

getThisOrCrashIfBad

public FQClassNameWithBaseDir getThisOrCrashIfBad(Readable readable_is,
                                         Writable writable_is)
                                           throws NoSuchFileException,
                                                  AccessDeniedException

Throws:

NoSuchFileException

AccessDeniedException

getThisOrCrashIfBad

public FQClassNameWithBaseDir getThisOrCrashIfBad(Existence existence_is,
                                         Readable readable_is,
                                         Writable writable_is)
                                           throws NoSuchFileException,
                                                  AccessDeniedException

Throws:

NoSuchFileException

AccessDeniedException

newLineIterator

public Iterator<String> newLineIterator()

getFileText

public String getFileText()

appendText

public StringBuilder appendText(StringBuilder to_appendTo)

newFileWriter

public PrintWriter newFileWriter()

getBaseDirectory

public String getBaseDirectory()

getClassName

public String getClassName()

getPath

public Path getPath()

getDotPlusExtension

public String getDotPlusExtension()

toString

public String toString()

Overrides:

toString in class Object

getObjectCopy

public FQClassNameWithBaseDir getObjectCopy()

Get a duplicate of this FQClassNameWithBaseDir.

Specified by:

getObjectCopy in interface Copyable

Returns:

(new FQClassNameWithBaseDir(this))

newLineIteratorForExistingReadable

public static final Iterator<String> newLineIteratorForExistingReadable(String base_dir,
                                                  String fq_className,
                                                  String dot_plusExtension)
                                                                 throws NoSuchFileException,
                                                                        AccessDeniedException

Throws:

NoSuchFileException

AccessDeniedException

newFileWriterForWriteable

public static final PrintWriter newFileWriterForWriteable(String base_dir,
                                    String fq_className,
                                    String dot_plusExtension)
                                                   throws NoSuchFileException,
                                                          AccessDeniedException

Throws:

NoSuchFileException

AccessDeniedException