Package com.helger.html.resource.js

Class ConstantJSPathProvider

java.lang.Object

com.helger.html.resource.js.ConstantJSPathProvider

All Implemented Interfaces:

IHTMLResourceProvider, IJSPathProvider, IJSProvider, Serializable

public final class ConstantJSPathProvider
extends Object
implements IJSPathProvider

An implementation of IJSPathProvider using constant paths.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.helger.html.resource.IHTMLResourceProvider

DEFAULT_IS_BUNDLABLE

Fields inherited from interface com.helger.html.resource.js.IJSProvider

DEFAULT_CONDITIONAL_COMMENT

Constructor Summary

Constructors

Constructor	Description
ConstantJSPathProvider(String sPath, String sMinifiedPath, String sConditionalComment, boolean bIsBundlable)

Method Summary

Modifier and Type	Method	Description
static ConstantJSPathProvider	create(String sPath)
static ConstantJSPathProvider	createBundlable(String sPath, boolean bBundlable)
static ConstantJSPathProvider	createExternal(String sURI)
static ConstantJSPathProvider	createExternal(String sURI, String sConditionalComment)
static ConstantJSPathProvider	createWithConditionalComment(String sPath, String sConditionalComment)
boolean	equals(Object o)
String	getConditionalComment()
String	getJSItemPath(boolean bRegular)	Get the path to this JavaScript resource.
String	getJSItemPathMinified()
String	getJSItemPathRegular()
int	hashCode()
boolean	isBundlable()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstantJSPathProvider

public ConstantJSPathProvider(@Nonnull @Nonempty
                              String sPath,
                              @Nonnull @Nonempty
                              String sMinifiedPath,
                              @Nullable
                              String sConditionalComment,
                              boolean bIsBundlable)

Method Detail

getJSItemPath

@Nonnull
@Nonempty
public String getJSItemPath(boolean bRegular)

Description copied from interface: IJSPathProvider

Get the path to this JavaScript resource. It is always classpath relative.

Specified by:

getJSItemPath in interface IJSPathProvider

Parameters:

bRegular - if true the regular version of item should be retrieved, otherwise the minified version of the file.

Returns:

The path to the external JS item.

getJSItemPathRegular

@Nonnull
@Nonempty
public String getJSItemPathRegular()

getJSItemPathMinified

@Nonnull
@Nonempty
public String getJSItemPathMinified()

getConditionalComment

@Nullable
public String getConditionalComment()

Specified by:

getConditionalComment in interface IJSProvider

Returns:

The conditional comment required for this JS item or null if it applies to all browsers.

isBundlable

public boolean isBundlable()

Specified by:

isBundlable in interface IHTMLResourceProvider

Specified by:

isBundlable in interface IJSProvider

Returns:

Whether or not this script can be bundled to a big JS profile. For some files this is not possible.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

create

@Nonnull
public static ConstantJSPathProvider create(@Nonnull @Nonempty
                                            String sPath)

createWithConditionalComment

@Nonnull
public static ConstantJSPathProvider createWithConditionalComment(@Nonnull @Nonempty
                                                                  String sPath,
                                                                  @Nullable
                                                                  String sConditionalComment)

createBundlable

@Nonnull
public static ConstantJSPathProvider createBundlable(@Nonnull @Nonempty
                                                     String sPath,
                                                     boolean bBundlable)

createExternal

@Nonnull
public static ConstantJSPathProvider createExternal(@Nonnull @Nonempty
                                                    String sURI)

createExternal

@Nonnull
public static ConstantJSPathProvider createExternal(@Nonnull @Nonempty
                                                    String sURI,
                                                    @Nullable
                                                    String sConditionalComment)