GlueGen Runtime 2.3.2 · com.jogamp.common.net.AssetURLContext

Modifier and Type	Field and Description
public static final String	asset_protocol The asset URL protocol name `asset`
public static final String	asset_protocol_prefix The asset URL protocol prefix `asset:`
public static final String	assets_folder The optional asset folder name with ending slash `assets/`.
private static final boolean	DEBUG

Access	Constructor and Description
public	AssetURLContext()

Method Summary

Modifier and Type	Method and Description
public static AssetURLContext	create(final ClassLoader cl)
public static AssetURLStreamHandler	createHandler(final ClassLoader cl)
public static URL	createURL(final String resource path, with or w/o `asset:` prefix path, final ClassLoader the ClassLoader used to resolve the location, see `getClassLoader()`. cl) Create an asset URL, suitable even w/o the registered asset URLStreamHandler.
public static URL	createURL(final String resource path, with or w/o `asset:` prefix path) Create an asset URL, suitable only with the registered asset URLStreamHandler.
public abstract ClassLoader	getClassLoader() Returns an asset aware ClassLoader.
public String	getImplementedProtocol() Implements com.jogamp.common.net.PiggybackURLContext.getImplementedProtocol. Returns the specific protocol, constant for this implementation.
public static URLStreamHandler	getRegisteredHandler() Returns the asset handler previously set via `registerHandler(ClassLoader)`, or null if none was set.
private static URLConnection	open(final URL url)
public static boolean	Returns: true if successful, otherwise false registerHandler(final ClassLoader cl) Registers the generic URLStreamHandlerFactory via `GenericURLStreamHandlerFactory#register()` and if successful sets the asset `handler` for the given ClassLoader `cl`.
public URLConnection	resolve(final String path) Implements com.jogamp.common.net.PiggybackURLContext.resolve. Resolving path to a URL sub protocol and return it's open URLConnection This implementation attempts to resolve `path` in the following order: as a valid URL: `new URL(path)`, use sub-protocol if asset URL via ClassLoader: `getClassLoader()`.`getResource(path)`, use sub-protocol if asset URL as a File: `new File(path).toURI().toURL()`
public static URLConnection	resolve(String path, final ClassLoader cl)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

asset_protocol	back to summary
public static final String asset_protocol The asset URL protocol name `asset`

asset_protocol_prefix	back to summary
public static final String asset_protocol_prefix The asset URL protocol prefix `asset:`

assets_folder	back to summary
public static final String assets_folder The optional asset folder name with ending slash `assets/`. Note that the asset folder is not used on all platforms using the asset protocol and you should not rely on it, use `AssetURLConnection#getEntryName()`.

DEBUG	back to summary
private static final boolean DEBUG

AssetURLContext	back to summary
public AssetURLContext()

Method Detail

create	back to summary
public static AssetURLContext create(final ClassLoader cl)

createHandler	back to summary
public static AssetURLStreamHandler createHandler(final ClassLoader cl)

createURL back to summary

createURL	back to summary
public static URL createURL(final String path, final ClassLoader cl) throws MalformedURLException Create an asset URL, suitable even w/o the registered asset URLStreamHandler. This is equivalent with: return new URL(null, path.startsWith("asset:") ? path : "asset:" + path, new AssetURLStreamHandler(cl)); Parameters path:String resource path, with or w/o `asset:` prefix cl:ClassLoader the ClassLoader used to resolve the location, see `getClassLoader()`.

public static URL createURL(final String path, final ClassLoader cl) throws MalformedURLException

Create an asset URL, suitable even w/o the registered asset URLStreamHandler.

This is equivalent with:

  return new URL(null, path.startsWith("asset:") ? path : "asset:" + path, new AssetURLStreamHandler(cl));

Parameters

path:String: resource path, with or w/o asset: prefix
cl:ClassLoader: the ClassLoader used to resolve the location, see getClassLoader().

createURL back to summary

createURL	back to summary
public static URL createURL(final String path) throws MalformedURLException Create an asset URL, suitable only with the registered asset URLStreamHandler. This is equivalent with: return new URL(path.startsWith("asset:") ? path : "asset:" + path); Parameters path:String resource path, with or w/o `asset:` prefix

public static URL createURL(final String path) throws MalformedURLException

Create an asset URL, suitable only with the registered asset URLStreamHandler.

This is equivalent with:

  return new URL(path.startsWith("asset:") ? path : "asset:" + path);

Parameters

path:String: resource path, with or w/o asset: prefix

getClassLoader back to summary

getClassLoader	back to summary
public abstract ClassLoader getClassLoader() Returns an asset aware ClassLoader. The ClassLoader is required to find the asset resource via it's `URL findResource(String)` implementation. It's `URL findResource(String)` implementation shall return either an asset URL `asset:sub-protocol` or just the sub-protocol URL. For example, on Android, we redirect all `path` request to assets/`path`.

public abstract ClassLoader getClassLoader()

Returns an asset aware ClassLoader.

The ClassLoader is required to find the asset resource via it's URL findResource(String) implementation.

It's URL findResource(String) implementation shall return either an asset URL asset:sub-protocol or just the sub-protocol URL.

For example, on Android, we redirect all path request to assets/path.

getImplementedProtocol	back to summary
public String getImplementedProtocol() Implements com.jogamp.common.net.PiggybackURLContext.getImplementedProtocol. Doc from com.jogamp.common.net.PiggybackURLContext.getImplementedProtocol. Returns the specific protocol, constant for this implementation. Annotations @Override

getImplementedProtocol

back to summary

public String getImplementedProtocol()

Implements com.jogamp.common.net.PiggybackURLContext.getImplementedProtocol.

Doc from com.jogamp.common.net.PiggybackURLContext.getImplementedProtocol.

Returns the specific protocol, constant for this implementation.

Annotations

@Override

getRegisteredHandler	back to summary
public static URLStreamHandler getRegisteredHandler() Returns the asset handler previously set via `registerHandler(ClassLoader)`, or null if none was set.

open	back to summary
private static URLConnection open(final URL url)

registerHandler back to summary

registerHandler	back to summary
public static boolean registerHandler(final ClassLoader cl) Registers the generic URLStreamHandlerFactory via `GenericURLStreamHandlerFactory#register()` and if successful sets the asset `handler` for the given ClassLoader `cl`. Returns:boolean true if successful, otherwise false

public static boolean registerHandler(final ClassLoader cl)

Registers the generic URLStreamHandlerFactory via GenericURLStreamHandlerFactory#register() and if successful sets the asset handler for the given ClassLoader cl.

Returns:boolean: true if successful, otherwise false

resolve back to summary

resolve	back to summary
public URLConnection resolve(final String path) throws IOException Implements com.jogamp.common.net.PiggybackURLContext.resolve. Doc from com.jogamp.common.net.PiggybackURLContext.resolve. Resolving path to a URL sub protocol and return it's open URLConnection This implementation attempts to resolve `path` in the following order: as a valid URL: `new URL(path)`, use sub-protocol if asset URL via ClassLoader: `getClassLoader()`.`getResource(path)`, use sub-protocol if asset URL as a File: `new File(path).toURI().toURL()` In case of using the ClassLoader (2) and if running on Android, the `assets_folder` is being prepended to `path` if missing. Annotations @Override

public URLConnection resolve(final String path) throws IOException

Implements com.jogamp.common.net.PiggybackURLContext.resolve.

Doc from com.jogamp.common.net.PiggybackURLContext.resolve.

Resolving path to a URL sub protocol and return it's open URLConnection

This implementation attempts to resolve path in the following order:

as a valid URL: new URL(path), use sub-protocol if asset URL
via ClassLoader: getClassLoader().getResource(path), use sub-protocol if asset URL
as a File: new File(path).toURI().toURL()

In case of using the ClassLoader (2) and if running on Android, the assets_folder is being prepended to path if missing.

Annotations

@Override

resolve	back to summary
public static URLConnection resolve(String path, final ClassLoader cl) throws IOException

public abstract Class AssetURLContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail