@awayjs/core/lib/library/AssetLibrary.ts

AwayJS core classes

import { EventBase } from '../events/EventBase';

import { URLRequest } from '../net/URLRequest';

import { ParserBase } from '../parsers/ParserBase';

import { AssetLibraryBundle } from './AssetLibraryBundle';
import { AssetLibraryIterator } from './AssetLibraryIterator';
import { ConflictStrategyBase } from './ConflictStrategyBase';
import { IAssetAdapter } from './IAssetAdapter';
import { Loader } from './Loader';
import { LoaderContext } from './LoaderContext';

/**
 * AssetLibrary enforces a singleton pattern and is not intended to be
 * instanced. It's purpose is to allow access to the default library bundle
 * through a set of static shortcut methods. If you are interested in creating
 * multiple library bundles, please use the <code>getBundle()</code> method.
 */
export class AssetLibrary {
	/**
	 * Creates a new <code>AssetLibrary</code> object.
	 *
	 */
	constructor() {
	}

	/**
	 * Returns an AssetLibrary bundle instance. If no key is given, returns the
	 * default bundle (which is similar to using the AssetLibraryBundle as a
	 * singleton). To keep several separated library bundles, pass a string key
	 * to this method to define which bundle should be returned. This is
	 * referred to as using the AssetLibraryBundle as a multiton.
	 *
	 * @param key Defines which multiton instance should be returned.
	 * @return An instance of the asset library
	 */
	public static getBundle(key: string = 'default'): AssetLibraryBundle {
		return AssetLibraryBundle.getInstance(key);
	}

	/**
	 *
	 */
	public static enableParser(parserClass): void {
		Loader.enableParser(parserClass);
	}

	/**
	 *
	 */
	public static enableParsers(parserClasses: Array<Object>): void {
		Loader.enableParsers(parserClasses);
	}

	/**
	 * Short-hand for conflictStrategy property on default asset library bundle.
	 *
	 * @see AssetLibraryBundle.conflictStrategy
	 */
	public static get conflictStrategy(): ConflictStrategyBase {
		return AssetLibrary.getBundle().conflictStrategy;
	}

	public static set conflictStrategy(val: ConflictStrategyBase) {
		AssetLibrary.getBundle().conflictStrategy = val;
	}

	/**
	 * Short-hand for conflictPrecedence property on default asset library bundle.
	 *
	 * @see AssetLibraryBundle.conflictPrecedence
	 */
	public static get conflictPrecedence(): string {
		return AssetLibrary.getBundle().conflictPrecedence;
	}

	public static set conflictPrecedence(val: string) {
		AssetLibrary.getBundle().conflictPrecedence = val;
	}

	/**
	 * Short-hand for createIterator() method on default asset library bundle.
	 *
	 * @see AssetLibraryBundle.createIterator()
	 */
	public static createIterator(assetTypeFilter: string = null,
		namespaceFilter: string = null,
		filterFunc = null): AssetLibraryIterator {
		return AssetLibrary.getBundle().createIterator(assetTypeFilter, namespaceFilter, filterFunc);
	}

	/**
	 * Short-hand for load() method on default asset library bundle.
	 *
	 * @see AssetLibraryBundle.load()
	 */
	public static load(req: URLRequest,
		context: LoaderContext = null,
		ns: string = null,
		parser: ParserBase = null): void {
		AssetLibrary.getBundle().load(req, context, ns, parser);
	}

	/**
	 * Short-hand for loadData() method on default asset library bundle.
	 *
	 * @see AssetLibraryBundle.loadData()
	 */
	public static loadData(data: any,
		context: LoaderContext = null,
		ns: string = null,
		parser: ParserBase = null): void {
		AssetLibrary.getBundle().loadData(data, context, ns, parser);
	}

	public static stop(): void {
		AssetLibrary.getBundle().stop();
	}

	public static getLoader(): Loader {
		return AssetLibrary.getBundle().getLoader();
	}

	/**
	 * Short-hand for getAsset() method on default asset library bundle.
	 *
	 * @see AssetLibraryBundle.getAsset()
	 */
	public static getAsset(name: string, ns: string = null): IAssetAdapter {
		return AssetLibrary.getBundle().getAsset(name, ns);
	}

	/**
	 * Short-hand for getAsset() method on default asset library bundle.
	 *
	 * @see AssetLibraryBundle.getAsset()
	 */
	public static getAllAssets(): Array<IAssetAdapter> {
		return AssetLibrary.getBundle().getAllAssets();
	}

	/**
	 * Short-hand for addEventListener() method on default asset library bundle.
	 */
	public static addEventListener(type: string, listener: (event: EventBase) => void): void {
		AssetLibrary.getBundle().addEventListener(type, listener);
	}

	/**
	 * Short-hand for removeEventListener() method on default asset library bundle.
	 */
	public static removeEventListener(type: string, listener: (event: EventBase) => void): void {
		AssetLibrary.getBundle().removeEventListener(type, listener);
	}

	/**
	 * Short-hand for hasEventListener() method on default asset library bundle.

	 public static hasEventListener(type:string):boolean
	 {
		return AssetLibrary.getBundle().hasEventListener(type);
	}

	 public static willTrigger(type:string):boolean
	 {
		return getBundle().willTrigger(type);
	}
	 */

	/**
	 * Short-hand for addAsset() method on default asset library bundle.
	 *
	 * @see AssetLibraryBundle.addAsset()
	 */
	public static addAsset(asset: IAssetAdapter): void {
		AssetLibrary.getBundle().addAsset(asset);
	}

	/**
	 * Short-hand for removeAsset() method on default asset library bundle.
	 *
	 * @param asset The asset which should be removed from the library.
	 * @param dispose Defines whether the assets should also be disposed.
	 *
	 * @see AssetLibraryBundle.removeAsset()
	 */
	public static removeAsset(asset: IAssetAdapter, dispose: boolean = true): void {
		AssetLibrary.getBundle().removeAsset(asset, dispose);
	}

	/**
	 * Short-hand for removeAssetByName() method on default asset library bundle.
	 *
	 * @param name The name of the asset to be removed.
	 * @param ns The namespace to which the desired asset belongs.
	 * @param dispose Defines whether the assets should also be disposed.
	 *
	 * @see AssetLibraryBundle.removeAssetByName()
	 */
	public static removeAssetByName(name: string, ns: string = null, dispose: boolean = true): IAssetAdapter {
		return AssetLibrary.getBundle().removeAssetByName(name, ns, dispose);
	}

	/**
	 * Short-hand for removeAllAssets() method on default asset library bundle.
	 *
	 * @param dispose Defines whether the assets should also be disposed.
	 *
	 * @see AssetLibraryBundle.removeAllAssets()
	 */
	public static removeAllAssets(dispose: boolean = true): void {
		AssetLibrary.getBundle().removeAllAssets(dispose);
	}

	/**
	 * Short-hand for removeNamespaceAssets() method on default asset library bundle.
	 *
	 * @see AssetLibraryBundle.removeNamespaceAssets()
	 */
	public static removeNamespaceAssets(ns: string = null, dispose: boolean = true): void {
		AssetLibrary.getBundle().removeNamespaceAssets(ns, dispose);
	}
}