Asset (BladeRunnerJS v1.5.1-0.gba3e1c0)

All Known Subinterfaces:

LinkedAsset, SourceModule
```
public interface Asset
```
An Asset is any file that lives within an App. Assets are responsible for transforming their input into a readable stream (e.g. compiling CoffeeScript to JavaScript). They also provide string names (decoupled from their location on disk) by which they can be referenced. This interface is used by classes that implement methods such as reading the file, calculating the require path of the Asset, or obtaining the MemoizedFile version of an Asset for monitoring it for changes.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`org.bladerunnerjs.model.AssetContainer`	`assetContainer()` The method returns the AssetContainer in which the Asset is contained.
`MemoizedFile`	`file()` The method returns a `MemoizedFile` object that provides similar methods to File and wraps a File object.
`java.lang.String`	`getAssetName()` The method returns the name of the Asset file.
`java.lang.String`	`getAssetPath()` The method returns the path to the Asset relative to the `App` that comprises it.
`java.lang.String`	`getPrimaryRequirePath()` The method returns the primary require path to the Asset, which is calculated based on the require prefix of its `AssetContainer` and the Asset name.
`java.io.Reader`	`getReader()` The method returns a `Reader` object for obtaining the content of the Asset.
`java.util.List<java.lang.String>`	`getRequirePaths()` The method returns the available require paths to the Asset.
`boolean`	`isRequirable()` BRJS distinguishes between Assets that may be required and those that may not.
`boolean`	`isScopeEnforced()` In order to encourage modularity, BRJS does not allow lower level entities to depend on higher level entities.

- Method Detail
  - getReader
```
java.io.Reader getReader()
                  throws java.io.IOException
```
    The method returns a Reader object for obtaining the content of the Asset.
    
    Returns:
    
    a Reader object for reading the current Asset's character stream
    
    Throws:
    
    java.io.IOException - if there are any exceptions while creating the Reader
  - file
```
MemoizedFile file()
```
    The method returns a MemoizedFile object that provides similar methods to File and wraps a File object. Several of the methods' return values are 'memoized' and only regenerated if properties on the underlying file on disk change. Changes are detected by using MemoizedValue and the FileModificationRegistry.
    
    Returns:
    
    a MemoizedFile object for obtaining the Asset within the BRJS structure and monitoring it for changes.
  - getAssetName
```
java.lang.String getAssetName()
```
    The method returns the name of the Asset file.
    
    Returns:
    
    a String object representing the name of the Asset file.
  - getAssetPath
```
java.lang.String getAssetPath()
```
    The method returns the path to the Asset relative to the App that comprises it.
    
    Returns:
    
    a String object representing the path to the Asset file relative to the App that comprises it.
  - getRequirePaths
```
java.util.List<java.lang.String> getRequirePaths()
```
    The method returns the available require paths to the Asset. An Asset may have one or more valid require paths, as desired. This list will include the primary require path for the Asset.
    
    Returns:
    
    a List of Strings object representing the available require paths to the Asset.
  - getPrimaryRequirePath
```
java.lang.String getPrimaryRequirePath()
```
    The method returns the primary require path to the Asset, which is calculated based on the require prefix of its AssetContainer and the Asset name.
    
    Returns:
    
    a String object representing the primary require path to the Asset.
  - assetContainer
```
org.bladerunnerjs.model.AssetContainer assetContainer()
```
    The method returns the AssetContainer in which the Asset is contained. An AssetContainer may be e.g. an Aspect, a Workbench, a TestPack, a Blade, a Bladeset or a library.
    
    Returns:
    
    an AssetContainer object that contains the Asset.
  - isScopeEnforced
```
boolean isScopeEnforced()
```
    In order to encourage modularity, BRJS does not allow lower level entities to depend on higher level entities. For example, a blade may not require an asset from the default aspect. This behaviour is called 'scope enforced' and may be set on a per AssetContainer basis. The method returns true if the scope is enforced, meaning that warnings about such out of scope require paths will be logged, or false, if these will be ignored and retrieved.
    
    Returns:
    
    a boolean object stating whether eventual invalid require path warnings will be logged.
  - isRequirable
```
boolean isRequirable()
```
    BRJS distinguishes between Assets that may be required and those that may not. Those that may not include Assets on the root directory level or directories. The method returns true if the current Asset may be required and false otherwise.
    
    Returns:
    
    a boolean stating whether the Asset may be required by another one.

Interface Asset

Method Summary

Method Detail

getReader

file

getAssetName

getAssetPath

getRequirePaths

getPrimaryRequirePath

assetContainer

isScopeEnforced

isRequirable