Index (Asset Pipeline For the JVM API Doc)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

AbstractAssetFile - Class in asset.pipeline: This is the base Asset File specification class.
AbstractAssetResolver - Class in asset.pipeline.fs: The abstract class for any helper methods in resolving files
AbstractAssetResolver(String) - Constructor in AbstractAssetResolver
AbstractProcessor - Class in asset.pipeline: Abstract implementation of the Processor interface
AbstractProcessor(AssetCompiler) - Constructor in AbstractProcessor: Constructor for building a Processor
AbstractUrlRewritingProcessor - Class in asset.pipeline.processors: Subclasses iterate over relative asset URLs in a base asset file and rewrites the URL relative to the base asset file.
AbstractUrlRewritingProcessor(AssetCompiler) - Constructor in AbstractUrlRewritingProcessor
addCacheDependency(String, AssetFile) - Method in CacheManager: Called during asset processing to add a dependent file to another file cache.
applyProcessors(ClassLoader) - Method in AssetSpecLoader: Loads processor.specs files and appends Processor implementations to matching AssetFile implementations.
AssetCompiler - Class in asset.pipeline: Build time compiler for assets.
AssetCompiler(def, def) - Constructor in AssetCompiler: Creates an instance of the compiler given passed input options
AssetConnection - Class in sun.net.www.protocol.asset
AssetConnection(URL) - Constructor in AssetConnection
AssetFile - Interface in asset.pipeline: Provides an interface for referencing files resolved by the Asset-Pipeline AssetResolvers
assetFileClasses() - Method in AssetHelper: @return The classes that implement the AssetFile interface
assetForFile(T, String, AssetFile, String) - Method in AbstractAssetResolver
assetForFileName(String) - Method in AssetHelper: Finds the AssetFile definition for the specified file name based on its extension
AssetHelper - Class in asset.pipeline: Helper class for resolving assets
assetMimeTypeForURI(String) - Method in AssetHelper: The asset content type for the given URI
AssetPipeline - Class in asset.pipeline: Provides methods for fetching contents of assets within the asset-pipeline
AssetPipelineConfigHolder - Class in asset.pipeline: Holder for Asset Pipeline's configuration Also Provides Helper methods for loading in config from properties
AssetPipelineResponseBuilder - Class in asset.pipeline
AssetPipelineResponseBuilder(String, String, String, Date) - Constructor in AssetPipelineResponseBuilder
AssetResolver - Interface in asset.pipeline.fs: A public interface defining a class that can resolve files
AssetSpecLoader - Class in asset.pipeline: Loads asset specification.
asyncCacheSave() - Method in CacheManager: Asynchronously starts a thread used to persist the cache to disk It also performs a debounce behavior so rapid calls to the save do not cause repeat saves

B

BabelJsProcessor - Class in asset.pipeline.processors
BabelJsProcessor(AssetCompiler) - Constructor in BabelJsProcessor
baseModule - Field in JsRequireProcessor

C

CacheManager - Class in asset.pipeline: A Cache Manager for the Asset-Pipeline runtime.
CachePersister - Class in asset.pipeline: Receives asynchronous cache persistance requests and executes them.
callDirective(String, String, AssetFile, Map) - Method in DirectiveProcessor
checkDateChanged() - Method in AssetPipelineResponseBuilder
checkETag() - Method in AssetPipelineResponseBuilder
ClasspathAssetResolver - Class in asset.pipeline.fs: Implementation of the AssetResolver interface for resolving files on the classpath.
ClasspathAssetResolver(String, String, String, ClassLoader) - Constructor in ClasspathAssetResolver
ClosureCompilerProcessor - Class in asset.pipeline.processors: A PostProcessor designed to minify javascript utilizing the Google Closure javascript compiler Under the hood this leverages Rhino AST Trees to process the file (but not the Rhino runtime) which makes this significantly faster than the UglifyJs or UglifyJs2 library.
ClosureCompilerProcessor(AssetCompiler) - Constructor in ClosureCompilerProcessor
commonJsModules - Field in JsRequireProcessor
compile() - Method in AssetCompiler
compile(AssetFile) - Method in DirectiveProcessor: Takes an AssetFile and compiles it to a final result based on input directives and setup Processors.
config - Field in AssetPipelineConfigHolder
connect() - Method in AssetConnection
convertGlobToRegEx(String) - Method in AbstractAssetResolver: A method for converting glob patterns into regex.
createCache(String, String, String, String) - Method in CacheManager: Creates a cache entry for a file.
createInputStreamClosure(T) - Method in AbstractAssetResolver
createInputStreamClosure(URL) - Method in ClasspathAssetResolver
createInputStreamClosure(File) - Method in FileSystemAssetResolver
createInputStreamClosure(ZipEntry) - Method in JarAssetResolver
CssAssetFile - Class in asset.pipeline: An AssetFile implementation for CSS This currently applies a CssProcessor onto the css that does relative url replacement with digest named files
CssMinifyPostProcessor - Class in asset.pipeline.processors: Minifies CSS as a PostProcessor.
CssMinifyPostProcessor() - Constructor in CssMinifyPostProcessor
CssProcessor - Class in asset.pipeline.processors: This Processor iterates over relative image paths in a CSS file and recalculates their path relative to the base file.
CssProcessor(AssetCompiler) - Constructor in CssProcessor

D

debounceSave(Integer) - Method in CachePersister: Asynchronously triggers a save with a debounce delay to reduce excessive persistence calls
delay - Field in CachePersister
directiveArgumentsFromGString(String) - Method in DirectiveProcessor
directivePattern - Field in HtmlAssetFile
DirectiveProcessor - Class in asset.pipeline: This processor is a base processor put in front of most asset processing.
DirectiveProcessor(String, AssetCompiler, ClassLoader) - Constructor in DirectiveProcessor
doNotInsertCacheDigestIntoUrlForCompiledExtension(String) - Method in AbstractUrlRewritingProcessor

E

encodingTypeDirective(def, def, def) - Method in DirectiveProcessor: Set your file encoding within your manifest
extensionFromURI(String) - Method in AssetHelper: Obtains the extension for the given URI

F

fileContents(AssetFile) - Method in DirectiveProcessor: Used for fetching the contents of a file be it a Generic unprocessable entity or an AssetFile with a processable stream
fileForFullName(String) - Method in AssetHelper: Obtains an AssetFile instance for the given URI
fileForUri(String, String, String, AssetFile) - Method in AssetHelper: Resolve an AssetFile for the given URI
fileNameWithoutExtensionFromArtefact(String, AssetFile) - Method in AssetHelper
FileSystemAssetResolver - Class in asset.pipeline.fs: Implementation of the AssetResolver interface for the file system
FileSystemAssetResolver(String, String, boolean) - Constructor in FileSystemAssetResolver
findCache(String, String, String) - Method in CacheManager: Returns the cache string value of a file if it exists in the cache and is unmodified since last checked
findDirectives(AssetFile, Map) - Method in DirectiveProcessor: Scans an AssetFile for directive patterns and builds a dependency tree
flush() - Method in MultiOutputStream

G

GenericAssetFile - Class in asset.pipeline: Generic implementation of the AssetFile interface This is used to reference objects that do not get otherwise processed.
getAllAssets() - Method in AssetCompiler: /*', '*
getAsset(String) - Method in AssetResolver: Resolves a file given a relative path to this particular resolver
getAsset(String, String, String, AssetFile) - Method in ClasspathAssetResolver
getAsset(String, String, String, AssetFile) - Method in FileSystemAssetResolver
getAsset(String, String, String, AssetFile) - Method in JarAssetResolver
getAssetFileWithExtension(String, String) - Method in AssetHelper: @param uri string representation of the asset file.
getAssets(String) - Method in AssetResolver
getAssets(String, String, String, Boolean, AssetFile, AssetFile) - Method in ClasspathAssetResolver
getAssets(String, String, String, Boolean, AssetFile, AssetFile) - Method in FileSystemAssetResolver: Implementation Requirements Should be able to take a relative to baseFile scenario
getAssets(String, String, String, Boolean, AssetFile, AssetFile) - Method in JarAssetResolver
getBaseFile() - Method in AssetFile: @return The base file
getByteDigest() - Method in AbstractAssetFile: Returns a HEX encoded byte digest of the file contents (preprocessed) This leverages the DigestStream wrapping the files inputStream for efficient calculation If the stream is not fully read yet it will consume the rest of the stream
getByteDigest() - Method in AssetFile
getByteDigest(byte[]) - Method in AssetHelper: Generates an MD5 Byte Digest from a byte array
getBytes() - Method in GenericAssetFile: Returns a byte array of the inputStream contents NOTE: For large files this could result in large memory issues.
getCanonicalPath() - Method in AbstractAssetFile: Returns the canonicalPath in the context of the AssetResolver file path structure.
getConfig() - Method in AssetPipelineConfigHolder
getContent() - Method in AssetConnection
getCurrentETag() - Method in AssetPipelineResponseBuilder
getDependencyList(String, String, String) - Method in AssetPipeline: Used for serving assets in development mode via the AssetController This method is NOT recommended for public use as behavior changes in production mode.
getDependencyTree(AssetFile) - Method in DirectiveProcessor: Builds a dependency tree for a particular file
getDigestString() - Method in AssetPipelineConfigHolder
getDirectivePattern() - Method in AbstractAssetFile: Returns the directive pattern used to perform bundling in the comments of the file it is possible for the pattern to be NULL if this file type does not support it
getDirectivePattern() - Method in AssetFile: Returns the directive pattern used for bundling directive matching.
getEncoding() - Method in AssetFile: @return The encoding to use
getExcludesForPathKey(String) - Method in AssetCompiler
getFileName(T) - Method in AbstractAssetResolver
getFileName(URL) - Method in ClasspathAssetResolver
getFileName(File) - Method in FileSystemAssetResolver
getFileName(ZipEntry) - Method in JarAssetResolver
getFlattenedRequireList(def) - Method in DirectiveProcessor: Returns a Flattened list of files based on the require tree This is useful for converting a script tag into several script tags for debugging
getHeaders() - Method in AssetPipelineResponseBuilder
getIncludesForPathKey(String) - Method in AssetCompiler
getInputStream() - Method in AbstractAssetFile: Executes the inputStreamSource() closure to fetch a new inputStream object In the case of a standard asset file this result is cached into a Byte Array and also wrapped in a DigestInputStream for efficient md5 digest generation
getInputStream() - Method in AssetConnection
getInputStream() - Method in AssetFile: An input stream for the AssetFile
getInputStream() - Method in GenericAssetFile: Returns an inputStream reference to the file.
getManifest() - Method in AssetPipelineConfigHolder
getMatchedDirectives() - Method in AssetFile: @return the list of matched directive options
getName() - Method in AbstractAssetFile: Returns the name of the file without the path elements
getName() - Method in AssetFile: The name of the asset file
getName() - Method in AssetResolver
getName() - Method in GenericAssetFile: The name of the file without all path elements @return
getParentPath() - Method in AbstractAssetFile: Gets the parent path of the file Behaves similarly to a File.getParent() method @return
getParentPath() - Method in AssetFile: The path to the parent
getParentPath() - Method in GenericAssetFile: Returns the parent path or directory with which this file belongs
getPath() - Method in AssetFile: The path to the asset file
getPossibleFileSpecs(String) - Method in AssetHelper: Returns the possible AssetFile classes for the given content type
getRelativeFile(String, String) - Method in AbstractAssetResolver
getRelativeFile(String, String) - Method in ClasspathAssetResolver
getRelativeFile(String, String) - Method in FileSystemAssetResolver
getRelativeFile(String, String) - Method in JarAssetResolver
getResolvers() - Method in AssetPipelineConfigHolder
getSourceResolver() - Method in AssetFile: The AssetResolver used to resolve the asset file
getStatusCode() - Method in AssetPipelineResponseBuilder

H

Handler - Class in sun.net.www.protocol.asset
headers - Field in AssetPipelineResponseBuilder
HtmlAssetFile - Class in asset.pipeline: An AssetFile implementation for Html This currently applies a HtmlProcessor onto the Html that does relative url replacement with digest named files
HtmlProcessor - Class in asset.pipeline.processors: This Processor iterates over relative image paths in an HTML file and recalculates their path relative to the base file.
HtmlProcessor(AssetCompiler) - Constructor in HtmlProcessor
HTTP_DATE_FORMAT - Field in AssetPipelineResponseBuilder

I

ifModifiedSinceHeader - Field in AssetPipelineResponseBuilder
ifNoneMatchHeader - Field in AssetPipelineResponseBuilder
isDigestVersion() - Method in AssetPipelineResponseBuilder
isFileInTree(AssetFile) - Method in DirectiveProcessor: Checks if a file reference is already in the dependency graph
isFileMatchingPatterns(String, List<String>) - Method in AbstractAssetResolver
isFileMatchingPatterns(String, List<String>) - Method in AssetHelper: Checks if a file path matches any pattern provided.
iterateOverFileSystem(File, List<String>, List<String>, List<AssetFile>, String) - Method in FileSystemAssetResolver

J

JarAssetResolver - Class in asset.pipeline.fs: Implementation of the AssetResolver interface for resolving from JAR files or ZIP files
JarAssetResolver(String, String, String) - Constructor in JarAssetResolver
JsAssetFile - Class in asset.pipeline: An AssetFile implementation for Javascript
JsEs6AssetFile - Class in asset.pipeline: An AssetFile implementation for ES6 Javascript
JsNodeInjectProcessor - Class in asset.pipeline.processors: This Processor iterates over a js file looking for asset_path directive sand replaces their path with absolute paths based on the configured.
JsNodeInjectProcessor(AssetCompiler) - Constructor in JsNodeInjectProcessor
JsProcessor - Class in asset.pipeline.processors: This Processor iterates over a js file looking for asset_path directive sand replaces their path with absolute paths based on the configured.
JsProcessor(AssetCompiler) - Constructor in JsProcessor
JsRequireProcessor - Class in asset.pipeline.processors
JsRequireProcessor(AssetCompiler) - Constructor in JsRequireProcessor

K

L

loadBabelJs() - Method in BabelJsProcessor
loadContentsForTree(Map, StringBuilder) - Method in DirectiveProcessor: Scans through a generated tree and builds a files contents recursively
loadPersistedCache() - Method in CacheManager: Loads an Asset Cache dependency graph for asset-pipeline.
loadRequiresForTree(def, def) - Method in DirectiveProcessor: Scans through a generated tree and builds a flatted list of requirements recursively
loadSpecifications(ClassLoader) - Method in AssetSpecLoader: Load the specifications and return a list of specification classes

M

main(String) - Method in AssetCompiler

Main Target Endpoint for Launching The AssetCompile in a Forked Execution Environment Arguments

-o compileDir
-i sourceDir (List of SourceDirs)
-j List of Source Jars (, delimited)
-d Digests
-z Compression
-m SourceMaps
-n Skip Non Digests
-c Config Location
command - compile,watch

This is NOT YET IMPLEMENTED

manifest - Field in AssetPipelineConfigHolder

MinifyException - Class in asset.pipeline.processors

When a Minify Closure parser error is reached this exception is thrown.

MinifyException(String) - Constructor in MinifyException

MultiOutputStream - Class in asset.pipeline.utils

An OutputStream capable of writing to a collection of output streams underneath simultaneously

MultiOutputStream(Collection<OutputStream>) - Constructor in MultiOutputStream

Constructor method for creating the input Stream

N

nameWithoutExtension(String) - Method in AssetHelper: Obtains the name of the file sans the extension
normalizePath(String) - Method in AssetHelper: Normalizes a path into a standard path, stripping out all path elements that walk the path (i.e. '..' and '.')

O

openConnection(URL) - Method in Handler

P

process(String, AssetFile) - Method in BabelJsProcessor: Processes an input string from a given AssetFile implementation of coffeescript and converts it to javascript
process(String, String, Map) - Method in ClosureCompilerProcessor
process(def, def) - Method in CssMinifyPostProcessor
process(String, AssetFile) - Method in CssProcessor
process(String, AssetFile) - Method in HtmlProcessor
process(String, AssetFile) - Method in JsNodeInjectProcessor
process(String, AssetFile) - Method in JsProcessor
process(String, AssetFile) - Method in JsRequireProcessor
process(String, AssetFile) - Method in Processor: Takes a String input and runs the relevant processor of the file contents.
processedStream(AssetCompiler, Boolean) - Method in AbstractAssetFile: Returns a Processed String of the files contents This includes a run through of all Processors in the processors List.
processedStream(AssetCompiler) - Method in AssetFile: Processes the AssetFile uses the Asset Processor instances
Processor - Interface in asset.pipeline: Processor for an AssetFile

Q

R

ran - Field in CachePersister
recursiveTreeAppend(File, List<AssetFile>, String, AssetFile, boolean, String) - Method in FileSystemAssetResolver
registerResolver(AssetResolver) - Method in AssetPipelineConfigHolder
relativePathToResolver(T, String) - Method in AbstractAssetResolver
relativePathToResolver(URL, String) - Method in ClasspathAssetResolver
relativePathToResolver(File, String) - Method in FileSystemAssetResolver
relativePathToResolver(ZipEntry, String) - Method in JarAssetResolver
replacementAssetPath(AssetFile, AssetFile, Boolean) - Method in AbstractUrlRewritingProcessor
replacementUrl(AssetFile, String) - Method in AbstractUrlRewritingProcessor
requireFileDirective(def, def, def) - Method in DirectiveProcessor: Directive which allows inclusion of individual files Example: //=require sample.js
requireFullTreeDirective(def, def, def) - Method in DirectiveProcessor: Loads files recursively within the specified relative path across ALL resolvers Example: //=require_full_tree /spud/admin
requireSelfDirective(def, def, def) - Method in DirectiveProcessor: Used to control file order for when content within your manifest exists
requireTreeDirective(def, def, def) - Method in DirectiveProcessor: Loads files recursively within the specified folder within the same source resolver Example: //=require_tree .
resolveAsset(def, String, String, AssetFile, String) - Method in AbstractAssetResolver
resolvers - Field in AssetPipelineConfigHolder
run() - Method in CachePersister
RUN_DELAY - Field in CachePersister

S

save() - Method in CacheManager: Called by the async CachePersister class to save the cache map to disk
scanForFiles(List<String>, List<String>) - Method in AssetResolver
scanForFiles(List<String>, List<String>) - Method in ClasspathAssetResolver: Uses file globbing to scan for files that need precompiled
scanForFiles(List<String>, List<String>) - Method in FileSystemAssetResolver: Uses file globbing to scan for files that need precompiled
scanForFiles(List<String>, List<String>) - Method in JarAssetResolver: Uses file globbing to scan for files that need precompiled
serveAsset(String, String, String, String) - Method in AssetPipeline: Used for serving assets in development mode via the AssetController This method is NOT recommended for public use as behavior changes in production mode.
serveUncompiledAsset(String, String, String, String) - Method in AssetPipeline: Used for serving assets in development mode without bundling This method is NOT recommended for public use as behavior changes in production mode.
setBaseFile(AssetFile) - Method in AssetFile: Sets the base file
setConfig(Map) - Method in AssetPipelineConfigHolder
setEncoding(String) - Method in AssetFile: Sets the encoding to use
setManifest(Properties) - Method in AssetPipelineConfigHolder
setMatchedDirectives(List<String>) - Method in AssetFile: set the matched directives list
setResolvers(Collection<AssetResolver>) - Method in AssetPipelineConfigHolder
statusCode - Field in AssetPipelineResponseBuilder

T

toString() - Method in AbstractAssetFile: String representation of the object defaults to the full path of the file @return
translateMinifyOptions(CompilerOptions, Map) - Method in ClosureCompilerProcessor