Package | Description |
---|---|
org.apache.velocity.tools.generic |
Contains a collection of reusable, general-purpose "tools" for Velocity.
|
org.apache.velocity.tools.view |
Contains tools and supporting infrastructure for using
those tools in a servlet environment as well as general
use classes to support use of Velocity as (or in) the
view layer of web applications.
|
Modifier and Type | Field and Description |
---|---|
protected LinkTool |
LinkTool.self |
Modifier and Type | Method and Description |
---|---|
LinkTool |
LinkTool.absolute()
Returns a copy of this LinkTool instance that has
setForceRelative(boolean) set to false and sets the
scheme to the "http" if no scheme has been set yet. |
LinkTool |
LinkTool.absolute(Object obj)
Returns a copy of the link with the specified URI reference
either used as or converted to an absolute (non-relative)
URI reference.
|
LinkTool |
LinkTool.anchor(Object anchor)
Returns a copy of the link with the specified anchor to be
added to the end of the generated hyperlink.
|
LinkTool |
LinkTool.append(Object pth)
Appends the given value to the end of the current
path value.
|
LinkTool |
LinkTool.append(Object key,
Object value)
Appends a new key=value pair to the existing query
data.
|
LinkTool |
LinkTool.directory()
Returns a new LinkTool instance with
the path set to the result of
getDirectory()
and the query and fragment set to null. |
protected LinkTool |
LinkTool.duplicate()
Equivalent to clone, but with no checked exceptions.
|
protected LinkTool |
LinkTool.duplicate(boolean deep)
Equivalent to clone, but with no checked exceptions.
|
LinkTool |
LinkTool.getSelf() |
LinkTool |
LinkTool.host(Object host)
Returns a new instance with the specified value set as its
host.
|
LinkTool |
LinkTool.insecure()
Returns a new instance with the scheme set to "http".
|
LinkTool |
LinkTool.param(Object key,
Object value)
Adds a key=value pair to the query data.
|
LinkTool |
LinkTool.params(Object parameters)
This method can do two different things.
|
LinkTool |
LinkTool.path(Object pth)
Returns a new instance with the specified value
set as its path.
|
LinkTool |
LinkTool.port(Object port)
Returns a new instance with the specified value set
as its port number.
|
LinkTool |
LinkTool.query(Object query)
Sets the specified value as the current query data,
after normalizing the pair delimiters.
|
LinkTool |
LinkTool.relative()
Returns a copy of this LinkTool instance that has
setForceRelative(boolean) set to true. |
LinkTool |
LinkTool.relative(Object obj)
Returns a copy of the link with the specified directory-relative
URI reference set as the end of the path and
setForceRelative(boolean)
set to true. |
LinkTool |
LinkTool.remove(Object key)
Returns a new LinkTool instance that has any
value(s) under the specified key removed from the query data.
|
LinkTool |
LinkTool.root()
Returns a new LinkTool instance that represents
the "root" of the current one, if it has one.
|
LinkTool |
LinkTool.scheme(Object scheme)
Returns a new instance with the specified value set as its scheme.
|
LinkTool |
LinkTool.secure()
Returns a new instance with the scheme set to "https".
|
LinkTool |
LinkTool.set(Object key,
Object value)
Sets a new key=value pair to the existing query
data, overwriting any previous pair(s) that have
the same key.
|
LinkTool |
LinkTool.uri(Object uri)
Returns a copy of the link with the given URI reference set.
|
LinkTool |
LinkTool.user(Object info)
Returns a new instance with the specified value
set as its user info.
|
Modifier and Type | Class and Description |
---|---|
class |
LinkTool
The LinkTool provides many methods to work with URIs and can help you:
construct full URIs (absolute or relative)
encode session ID into a URI
retrieve server, port and path info for the current request
reconstruct or alter the current request URI
and more..
|
Copyright © 2002–2018 The Apache Software Foundation. All rights reserved.