public final class TagLibraryIndexWriter extends java.lang.Object
Writes the compile-time descriptor for a single tag library.
Two files are produced per tag library: a descriptor named after the tag library class, and an
entry in a shared index.properties manifest naming it. The manifest exists because a
classpath directory cannot be enumerated from inside a jar, so the reader needs the names up front.
Both live under TagLibraryIndex.INDEX_LOCATION and merge across jars without a build step.
| Type Params | Return Type | Name and description |
|---|---|---|
|
public static void |
clear(java.io.File outputDirectory)Removes any index previously written beneath a directory, so that a regenerated index describes only the tag libraries that exist now. |
|
public static void |
write(java.io.File outputDirectory, java.lang.String className, java.lang.String namespace, java.util.Collection<java.lang.String> tagNames)Writes the descriptor for a tag library into a compiler output directory. |
|
public static void |
writeIncomplete(java.io.File outputDirectory, java.util.Collection<java.lang.String> namespaces, boolean everything)Records what could not be described, so that a call to a tag of an incompletely described namespace is never reported as a misspelling. |
| Methods inherited from class | Name |
|---|---|
class java.lang.Object |
java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int) |
Removes any index previously written beneath a directory, so that a regenerated index describes only the tag libraries that exist now. Without this a renamed or deleted tag library would keep a descriptor, and the manifest naming it, until the build directory was cleaned.
outputDirectory - the directory the index is written beneathWrites the descriptor for a tag library into a compiler output directory.
outputDirectory - the compilation target directory; nothing is written when nullclassName - the binary name of the tag librarynamespace - the namespace the tag library declarestagNames - the tag names the tag library declaresRecords what could not be described, so that a call to a tag of an incompletely described namespace is never reported as a misspelling.
outputDirectory - the directory the index is written beneathnamespaces - the namespaces known to be missing some of their tagseverything - true when what was missed could not be attributed to a namespace at all, in
which case nothing in the index may be treated as complete