Class Index | File Index

Classes


Class URLContent


Defined in: URLContent.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
URLContent(url)
Content wrapper for strings used as URLs.
Method Summary
Method Attributes Method Name and Description
 
equals(obj)
Returns true if the object in parameter is an URL content that references the same URL as this object.
<static>  
URLContent.fromURL(url)
Returns an instance of URLContent matching the given url.
 
Returns the name of a JAR entry.
 
Returns the URL base of a JAR entry.
 
getStreamURL(observer)
Retrieves asynchronously an URL of this content usable for JavaScript functions with URL paramater.
 
Returns the URL of this content.
 
Returns a hash code for this object.
 
Returns true if the URL stored by this content references an entry in a JAR.
 
Returns true if this content URL is available to be read.
Class Detail
URLContent(url)
Content wrapper for strings used as URLs.
Author: Emmanuel Puybaret.
Parameters:
{string} url
the URL from which this content will be read
Method Detail
{boolean} equals(obj)
Returns true if the object in parameter is an URL content that references the same URL as this object.
Parameters:
obj
Returns:
{boolean}

<static> {URLContent} URLContent.fromURL(url)
Returns an instance of URLContent matching the given url.
Parameters:
{string} url
Returns:
{URLContent}

{string} getJAREntryName()
Returns the name of a JAR entry. If the JAR entry in the URL given at creation time was encoded in application/x-www-form-urlencoded format, this method will return it unchanged and not decoded.
Throws:
IllegalStateException if the URL of this content doesn't reference an entry in a JAR URL.
Returns:
{string}

{string} getJAREntryURL()
Returns the URL base of a JAR entry.
Returns:
{string}

getStreamURL(observer)
Retrieves asynchronously an URL of this content usable for JavaScript functions with URL paramater.
Parameters:
{{urlReady: function|urlError: function}} observer
optional observer which urlReady function will be called asynchronously once URL is available.

{string} getURL()
Returns the URL of this content.
Returns:
{string}

{Number} hashCode()
Returns a hash code for this object.
Returns:
{Number}

{boolean} isJAREntry()
Returns true if the URL stored by this content references an entry in a JAR.
Returns:
{boolean}

isStreamURLReady()
Returns true if this content URL is available to be read.

© Copyright 2024 Space Mushrooms
Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Aug 21 2024 17:43:25 GMT+0200 (CEST)