Module com.aoapps.web.resources.registry

Package com.aoapps.web.resources.registry

Class Script

java.lang.Object

com.aoapps.web.resources.registry.Resource<Script>

com.aoapps.web.resources.registry.Script

All Implemented Interfaces:

Serializable, Comparable<Script>

public final class Script
extends Resource<Script>
implements Comparable<Script>

A script is identified by URI, but has other constraints. Including:

1. an async attribute
2. an defer attribute
3. an optional crossorigin attribute
4. TODO: Add more attributes as-needed

Optimizers should be careful to only group stylesheets that have equivalent constraints.

TODO: Support inline scripts without URI (defer and async not allowed for inline).

TODO: Support modules.

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Script.Builder	Builder pattern for Script.
static enum	Script.Position	The set of allowed script locations.

Field Summary

Fields

Modifier and Type	Field	Description
static final Comparator<Script>	COMPARATOR	Scripts start with a default ordering that should minimize the number of explicit ordering declarations.

Constructor Summary

Constructors

Constructor	Description
Script(String src)	Creates a new script.
Script(String src, Script.Position position, boolean async, boolean defer, String crossorigin)	Creates a new script.

Method Summary

Modifier and Type	Method	Description
static Script.Builder	builder()
int	compareTo(Script o)	All concrete implementations of Resource must be comparable to themselves.
boolean	equals(Object obj)	Two resources may be compared to see if they are exactly equal, including all relevant attributes.
String	getCrossorigin()	Gets the optional crossorigin policy.
Script.Position	getPosition()	Gets this script position.
int	hashCode()	The hash key must be consistent with Resource.equals(java.lang.Object).
boolean	isAsync()	Gets this script is asynchronous.
boolean	isDefer()	Gets this script is deferred.
String	toString()

Methods inherited from class com.aoapps.web.resources.registry.Resource

getUri

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

COMPARATOR

public static final Comparator<Script> COMPARATOR

Scripts start with a default ordering that should minimize the number of explicit ordering declarations.

1. Order by async, true first
2. Order by defer, true first
3. Order by URI

Note: The crossorigin policy is not used in ordering.

All string comparisons are performed via SmartComparator.ROOT.

Constructor Details

Script

public Script(String src,
 Script.Position position,
 boolean async,
 boolean defer,
 String crossorigin)

Creates a new script.

Parameters:

src - See Resource.getUri()

position - See getPosition()

async - See isAsync()

defer - See isDefer()

crossorigin - See getCrossorigin()

Script

public Script(String src)

Creates a new script.

Parameters:

src - See Resource.getUri()

Method Details

builder

public static Script.Builder builder()

toString

public String toString()

Overrides:

toString in class Resource<Script>

See Also:

• Resource.toString()
• getPosition()
• isAsync()
• isDefer()
• getCrossorigin()

equals

public boolean equals(Object obj)

Description copied from class: Resource

Two resources may be compared to see if they are exactly equal, including all relevant attributes.

Specified by:

equals in class Resource<Script>

hashCode

public int hashCode()

Description copied from class: Resource

The hash key must be consistent with Resource.equals(java.lang.Object).

Specified by:

hashCode in class Resource<Script>

compareTo

public int compareTo(Script o)

All concrete implementations of Resource must be comparable to themselves.

This default implementation compares by URI only via SmartComparator.ROOT.

Specified by:

compareTo in interface Comparable<Script>

Overrides:

compareTo in class Resource<Script>

See Also:

• COMPARATOR

getPosition

public Script.Position getPosition()

Gets this script position.

isAsync

public boolean isAsync()

Gets this script is asynchronous.

isDefer

public boolean isDefer()

Gets this script is deferred.

getCrossorigin

public String getCrossorigin()

Gets the optional crossorigin policy.