Package org.opengrok.web

Class Scripts

java.lang.Object

org.opengrok.web.Scripts

All Implemented Interfaces:

Iterable<Scripts.Script>

public class Scripts
extends Object
implements Iterable<Scripts.Script>

A list-like container for JavasScript sources in JSP/HTML pages.

Author:

Krystof Tulinger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Scripts.FileScript	Script implementing the toHtml() method as an external script resource.
static class	Scripts.Script	A script wrapper.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Map<String,Scripts.Script>	SCRIPTS

Constructor Summary

Constructors

Constructor	Description
Scripts()

Method Summary

Modifier and Type	Method	Description
boolean	addScript(String contextPath, String scriptName, org.opengrok.web.Scripts.Type type)	Add a script which is identified by the name.
void	addScript(Scripts.Script script)	Add a script to the page, taking the script priority into account.
boolean	isEmpty()	Check if there is any script for this page.
@NotNull Iterator<Scripts.Script>	iterator()	Iterator over the page scripts.
int	size()	Return the size of the page scripts.
String	toHtml()	Convert the page scripts into HTML.
String	toString()	Return the HTML representation of the page scripts.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

SCRIPTS

protected static final Map<String,Scripts.Script> SCRIPTS

Constructor Details

Scripts

public Scripts()

Method Details

toHtml

public String toHtml()

Convert the page scripts into HTML.

Returns:

the HTML

toString

public String toString()

Return the HTML representation of the page scripts.

Overrides:

toString in class Object

Returns:

the HTML

See Also:

• toHtml()

size

public int size()

Return the size of the page scripts.

Returns:

the size

See Also:

• List.size()

isEmpty

public boolean isEmpty()

Check if there is any script for this page.

Returns:

true if there is not; false otherwise

See Also:

• List.isEmpty()

iterator

@NotNull
public @NotNull Iterator<Scripts.Script> iterator()

Iterator over the page scripts.

Specified by:

iterator in interface Iterable<Scripts.Script>

Returns:

the iterator

See Also:

• List.iterator()

addScript

public boolean addScript(String contextPath,
 String scriptName,
 org.opengrok.web.Scripts.Type type)

Add a script which is identified by the name.

Parameters:

contextPath - given context path for the used URL

scriptName - name of the script

type - type of the script to add

Returns:

true if script was added; false otherwise

addScript

public void addScript(Scripts.Script script)

Add a script to the page, taking the script priority into account.

Parameters:

script - the script