oracle.jdeveloper.jsp.libraries
Class JspLibrary

java.lang.Object
  oracle.ide.model.DefaultDisplayable
      oracle.ide.model.DefaultElement
          oracle.jdeveloper.webapp.libraries.TagLibrary
              oracle.jdeveloper.jsp.libraries.JspLibrary

All Implemented Interfaces:

Displayable, Element, DisplayableTagLibrary

public class JspLibrary
extends TagLibrary

Instances of this class represent JSP Tag Libraries avialiable within the JDeveloper.
When JSP Tag Library is used (deployed) in a web project, associated libraries are added to the project and their archives are copied to the WEB-INF/lib folder. In case when there are no associated libraries, archive that contains Tag Library Descriptor (TLD) will be added to the project's class path, and copied to the WEB-INF/lib folder.

Field Summary

Fields inherited from class oracle.jdeveloper.webapp.libraries.TagLibrary

prefferedPrefix, RUN_TAGS_IN_EDITOR_BY_DEFAULT, version

Constructor Summary

JspLibrary(JspLibrary jsplibrary)
Copy constructor.

JspLibrary(java.lang.String tldURL, java.lang.String uri, java.lang.String libraryName, java.lang.String libraries)
Deprecated.

JspLibrary(java.net.URL taglibURL, java.lang.String uri, java.lang.String libraryName, java.lang.String libraries)
This creates a JspLibrary object that can be registered with JDeveloper.

Method Summary

static void	copy(JspLibrary src, JspLibrary dst) Copy utility method.
boolean	equals(java.lang.Object obj)
java.lang.String	getJspLibraries()
java.lang.String	getJspVersion() If JSP version is not explicitly set, it will be deduced from information in TLD file.
java.lang.String	getMaxJspVersion() If last JSP version is not explicitly set, it will return null.
oracle.jdeveloper.webapp.taglib.model.AbstractTaglib	getTaglib() Get the AbstractTaglib object.
protected java.lang.String	getTaglibURLExt() Return default extension file for the taglib
int	hashCode()
protected void	initFromTaglib() Init the tag library fields.
void	reportMissingData()
void	setAvailableProperties(TagLibrary target) This should be avialable only to "friendly" classes.
void	setJspLibraries(java.lang.String jspLibraries) Set the JSP tag libraries that should be added to the active project whenever any tags belonging to this taglib are used.
void	setJspVersion(java.lang.String jspVersion) Sets mimimal required version of the JSP for this library to work.
void	setMaxJspVersion(java.lang.String jspVersion) Sets last version of the JSP that this library will work in.
java.lang.String	toString() This implementation delegates to DefaultDisplayable.getShortLabel().

Methods inherited from class oracle.jdeveloper.webapp.libraries.TagLibrary

copy, getCustomizedRunInEditorTagNames, getIconURL, getLibraries, getLibraryIds, getName, getPrefix, getRunInEditor, getShortLabel, getShowInPalette, getTaglibURL, getTechnologyScope, getURI, getVersion, isMutable, setCustomizedRunInEditorTagNames, setIcon, setLibraries, setMutable, setName, setPrefix, setRunInEditor, setShowInPalette, setTaglibURL, setTechnologyScope, setURI, setVersion

Methods inherited from class oracle.ide.model.DefaultElement

getAttributes, getChildren, getData, mayHaveChildren

Methods inherited from class oracle.ide.model.DefaultDisplayable

getIcon, getLongLabel, getToolTipText

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.model.Element

getAttributes, getChildren, getData, mayHaveChildren

Methods inherited from interface oracle.ide.model.Displayable

getIcon, getLongLabel, getToolTipText

Constructor Detail

JspLibrary

public JspLibrary(java.lang.String tldURL,
                  java.lang.String uri,
                  java.lang.String libraryName,
                  java.lang.String libraries)

Deprecated.

This creates a JspLibrary object that can be registered with JDeveloper. None of the parameters can be null.

Parameters:

tldURL - - the location of the TLD file. Note that you can use macros to specify relative urls to oracle home. ex. @oracle.home@/jdev/mylibraries/taglib.tld.

uri - - the namespace of this tag library.

libraryName - - the name to be used to identify this taglib.

libraries - - semi-column delimited list of Java library IDs that will be deployed when this tag library is used.

JspLibrary

public JspLibrary(java.net.URL taglibURL,
                  java.lang.String uri,
                  java.lang.String libraryName,
                  java.lang.String libraries)

This creates a JspLibrary object that can be registered with JDeveloper. None of the parameters can be null.

Parameters:

taglibURL - - the location of the tag library. It can be TLD file location, or the folder for implicit .tag libraries.

uri - - the namespace of this tag library.

libraryName - - the name to be used to identify this taglib.

libraries - - semi-column delimited list of Java library IDs that will be deployed when this tag library is used.

JspLibrary

public JspLibrary(JspLibrary jsplibrary)

Copy constructor. This performs deep copying.

Method Detail

setAvailableProperties

public void setAvailableProperties(TagLibrary target)

This should be avialable only to "friendly" classes. Copies to target only non-required properties that are explicitly set. Avoids loading data from TLD file.

Specified by:

setAvailableProperties in class TagLibrary

Parameters:

target -

getTaglib

public oracle.jdeveloper.webapp.taglib.model.AbstractTaglib getTaglib()

Description copied from class: TagLibrary

Get the AbstractTaglib object.

Specified by:

getTaglib in class TagLibrary

Returns:

AbstractTaglib The AbstractTaglib object.

setJspLibraries

public void setJspLibraries(java.lang.String jspLibraries)

Set the JSP tag libraries that should be added to the active project whenever any tags belonging to this taglib are used. This is semi-column delimited string of JSP library names. Example: "JSTL Core;Struts HTML". Libraries can also be versioned by adding its version number after the name seperated by comma. Example: "JSTL Core,1.0;Struts HTML".

Parameters:

jspLibraries - the semi-column delimited string of JSP tag library names.

getJspLibraries

public java.lang.String getJspLibraries()

See Also:

setJspLibraries(String)

setJspVersion

public void setJspVersion(java.lang.String jspVersion)

Sets mimimal required version of the JSP for this library to work.

Parameters:

jspVersion - One of "1.1", "1.2", "2.0" ...

getJspVersion

public java.lang.String getJspVersion()

If JSP version is not explicitly set, it will be deduced from information in TLD file.

See Also:

setJspVersion(String)

setMaxJspVersion

public void setMaxJspVersion(java.lang.String jspVersion)

Sets last version of the JSP that this library will work in.

Parameters:

jspVersion - One of "1.1", "1.2", "2.0" ...

getMaxJspVersion

public java.lang.String getMaxJspVersion()

If last JSP version is not explicitly set, it will return null. Null value means that library is not upwards bounded. The version is inclusive (library will work in specified max version).

See Also:

setMaxJspVersion(String)

copy

public static void copy(JspLibrary src,
                        JspLibrary dst)

Copy utility method. This performs deep copying.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Description copied from class: DefaultDisplayable

This implementation delegates to DefaultDisplayable.getShortLabel().

Specified by:

toString in interface Displayable

Overrides:

toString in class DefaultDisplayable

See Also:

Displayable.toString()

initFromTaglib

protected void initFromTaglib()

Description copied from class: TagLibrary

Init the tag library fields.

Specified by:

initFromTaglib in class TagLibrary

reportMissingData

public void reportMissingData()

Overrides:

reportMissingData in class TagLibrary

getTaglibURLExt

protected java.lang.String getTaglibURLExt()

Description copied from class: TagLibrary

Return default extension file for the taglib

Specified by:

getTaglibURLExt in class TagLibrary

Returns: