Class EscapeURI

java.lang.Object

net.sf.saxon.expr.ComputedExpression

net.sf.saxon.expr.FunctionCall

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.EscapeURI

All Implemented Interfaces:

Serializable, SourceLocator, Container, Expression, InstructionInfoProvider

public class EscapeURI
extends SystemFunction

This class supports the functions encode-for-uri() and iri-to-uri()

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ENCODE_FOR_URI
static final int	HTML_URI
static final int	IRI_TO_URI

Fields inherited from class SystemFunction

operation

Fields inherited from class FunctionCall

argument

Fields inherited from class ComputedExpression

locationId, staticProperties

Fields inherited from interface Expression

EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD

Constructor Summary

Constructors

Constructor	Description
EscapeURI()

Method Summary

Modifier and Type	Method	Description
static CharSequence	escape(CharSequence s, String allowedPunctuation)	Escape special characters in a URI.
Item	evaluateItem(XPathContext c)	Evaluate the function
static CharSequence	iriToUri(CharSequence s)	Escape special characters in a URI.

Methods inherited from class SystemFunction

addContextDocumentArgument, checkArguments, computeCardinality, computeSpecialProperties, display, getDetails, getErrorCodeForTypeErrors, getItemType, getRequiredType, main, makeSystemFunction, setDetails, useContextItemAsDefault

Methods inherited from class FunctionCall

checkArgumentCount, getArguments, getDisplayName, getFunctionNameCode, getNumberOfArguments, iterateSubExpressions, optimize, preEvaluate, promote, replaceSubExpression, setArguments, setFunctionNameCode, simplify, simplifyArguments, typeCheck

Methods inherited from class ComputedExpression

adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getInstructionInfo, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, iterate, markTailFunctionCalls, process, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation, typeError

Methods inherited from class Object

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

Field Details

ENCODE_FOR_URI

public static final int ENCODE_FOR_URI

See Also:

• Constant Field Values

IRI_TO_URI

public static final int IRI_TO_URI

See Also:

• Constant Field Values

HTML_URI

public static final int HTML_URI

See Also:

• Constant Field Values

Constructor Details

EscapeURI

public EscapeURI()

Method Details

evaluateItem

public Item evaluateItem(XPathContext c)
                  throws XPathException

Evaluate the function

Specified by:

evaluateItem in interface Expression

Overrides:

evaluateItem in class ComputedExpression

Parameters:

c - The context in which the expression is to be evaluated

Returns:

the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence

Throws:

XPathException - if any dynamic error occurs evaluating the expression

iriToUri

public static CharSequence iriToUri(CharSequence s)

Escape special characters in a URI. The characters that are %HH-encoded are all non-ASCII characters

Parameters:

s - the URI to be escaped

Returns:

the %HH-encoded string

escape

public static CharSequence escape(CharSequence s,
 String allowedPunctuation)

Escape special characters in a URI. The characters that are %HH-encoded are all non-ASCII characters, plus all ASCII characters except (a) letter A-Z and a-z, (b) digits 0-9, and (c) characters listed in the allowedPunctuation argument

Parameters:

s - the URI to be escaped

allowedPunctuation - ASCII characters other than letters and digits that should NOT be %HH-encoded

Returns:

the %HH-encoded string