// Jericho HTML Parser - Java based library for analysing and manipulating HTML
// Version 3.2
// Copyright (C) 2004-2009 Martin Jericho
// http://jericho.htmlparser.net/
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of either one of the following licences:
//
// 1. The Eclipse Public License (EPL) version 1.0,
// included in this distribution in the file licence-epl-1.0.html
// or available at http://www.eclipse.org/legal/epl-v10.html
//
// 2. The GNU Lesser General Public License (LGPL) version 2.1 or later,
// included in this distribution in the file licence-lgpl-2.1.txt
// or available at http://www.gnu.org/licenses/lgpl.txt
//
// This library is distributed on an "AS IS" basis,
// WITHOUT WARRANTY OF ANY KIND, either express or implied.
// See the individual licence texts for more details.
package net.htmlparser.jericho;
import java.util.*;
/**
* Encapsulates global configuration properties which determine the behaviour of various functions.
* <p>
* All of the properties in this class are static, affecting all objects and threads.
* Multiple concurrent configurations are not possible.
* <p>
* Properties that relate to <a target="_blank" href="http://www.w3.org/TR/html401/conform.html#didx-user_agent">user agent</a>
* compatibility issues are stored in instances of the {@link Config.CompatibilityMode} class.
* This allows all of the properties in the compatibility mode to be set as a block by setting the static
* {@link #CurrentCompatibilityMode} property to a different instance.
*
* @see Config.CompatibilityMode
*/
public final class Config {
private Config() {}
/**
* Determines the string used to separate a single column's multiple values in the output of the {@link FormFields#getColumnValues(Map)} method.
* <p>
* The situation where a single column has multiple values only arises if {@link FormField#getUserValueCount()}<code>>1</code>
* on the relevant form field, which usually indicates a poorly designed form.
* <p>
* The default value is "<code>,</code>" (a comma, not including the quotes).
* <p>
* Must not be <code>null</code>.
*/
public static String ColumnMultipleValueSeparator=",";
/**
* Determines the string that represents the value <code>true</code> in the output of the {@link FormFields#getColumnValues(Map)} method.
* <p>
* The default value is "<code>true</code>" (without the quotes).
* <p>
* Must not be <code>null</code>.
*/
public static String ColumnValueTrue=Boolean.toString(true);
/**
* Determines the string that represents the value <code>false</code> in the output of the {@link FormFields#getColumnValues(Map)} method.
* <p>
* The default value is <code>null</code>, which represents no output at all.
*/
public static String ColumnValueFalse=null;
/**
* Determines whether the {@link CharacterReference#decode(CharSequence)} and similar methods convert non-breaking space ({@link CharacterEntityReference#_nbsp }) character references to normal spaces.
* <p>
* The default value is <code>true</code>.
* <p>
* When this property is set to <code>false</code>, non-breaking space ({@link CharacterEntityReference#_nbsp })
* character references are decoded as non-breaking space characters (U+00A0) instead of being converted to normal spaces (U+0020).
* <p>
* The default behaviour of the library reflects the fact that non-breaking space character references are almost always used in HTML documents
* as a <a target="_blank" href="http://en.wikipedia.org/wiki/Non-breaking_space#Use_as_non-collapsing_whitespace">non-collapsing white space</a> character.
* Converting them to the correct character code U+00A0, which is represented by a visible character in many older character sets, was confusing to most users
* who expected to see only normal spaces.
* The most common example of this is its visualisation as the character <b>á</b> in the MS-DOS <a target="_blank" href="http://en.wikipedia.org/wiki/Code_page_437">CP437</a> character set.
* <p>
* The functionality of the following methods is affected:
* <ul>
* <li>{@link CharacterReference#appendCharTo(Appendable)}
* <li>{@link CharacterReference#decode(CharSequence)}
* <li>{@link CharacterReference#decode(CharSequence, boolean insideAttributeValue)}
* <li>{@link CharacterReference#decodeCollapseWhiteSpace(CharSequence)}
* <li>{@link CharacterReference#reencode(CharSequence)}
* <li>{@link Attribute#getValue()}
* <li>{@link Attributes#getValue(String name)}
* <li>{@link Attributes#populateMap(Map, boolean convertNamesToLowerCase)}
* <li>{@link StartTag#getAttributeValue(String attributeName)}
* <li>{@link Element#getAttributeValue(String attributeName)}
* <li>{@link FormControl#getPredefinedValues()}
* <li>{@link OutputDocument#replace(Attributes, boolean convertNamesToLowerCase)}
* <li>{@link Renderer#getConvertNonBreakingSpaces()}
* <li>{@link TextExtractor#getConvertNonBreakingSpaces()}
* </ul>
*/
public static boolean ConvertNonBreakingSpaces=true;
/**
* Determines the currently active {@linkplain Config.CompatibilityMode compatibility mode}.
* <p>
* The default setting is {@link Config.CompatibilityMode#IE} (MS Internet Explorer 6.0).
* <p>
* Must not be <code>null</code>.
*/
public static CompatibilityMode CurrentCompatibilityMode=CompatibilityMode.IE;
/**
* Determines whether apostrophes are encoded when calling the {@link CharacterReference#encode(CharSequence)} method.
* <p>
* A value of <code>false</code> means {@linkplain CharacterEntityReference#_apos apostrophe}
* (U+0027) characters are not encoded.
* The only time apostrophes need to be encoded is within an attribute value delimited by
* single quotes (apostrophes), so in most cases ignoring apostrophes is perfectly safe and
* enhances the readability of the source document.
* <p>
* Note that apostrophes are always encoded as a {@linkplain NumericCharacterReference numeric character reference}, never as the
* character entity reference {@link CharacterEntityReference#_apos '}.
* <p>
* The default value is <code>false</code>.
*/
public static boolean IsApostropheEncoded=false;
/**
* Determines whether all {@linkplain StartTag#isEmptyElementTag() empty-element tags} are recognised.
* <p>
* The major browsers do not recognise empty-element tags (those having the characters "/>" at the end of the start tag) if the element is defined by the
* HTML specification to have a {@linkplain HTMLElements#getEndTagRequiredElementNames() required} or an {@linkplain HTMLElements#getEndTagOptionalElementNames() optional} end tag.
* This is the case even in <a target="_blank" href="http://www.w3.org/TR/xhtml1/">XHTML</a> documents, which can cause a lot of confusion.
* <p>
* Setting this property to <code>true</code> forces the parser to recognise all {@linkplain StartTag#isSyntacticalEmptyElementTag() syntactical empty-element tags},
* regardless of whether the element is defined by the HTML specification to have a required or optional end tag.
* <p>
* Use of this feature is however not recommended as it makes the parser behaviour inconsistent with that of most browsers.
* <p>
* The default value is <code>false</code>.
*
* @see StartTag#isEmptyElementTag()
*/
public static boolean IsHTMLEmptyElementTagRecognised=false;
/**
* Determines the {@link LoggerProvider} that is used to create the default {@link Logger} object for each new {@link Source} object.
* <p>
* The {@link LoggerProvider} interface contains several predefined <code>LoggerProvider</code> instances which this property can be set to,
* mostly representing wrappers to common logging frameworks.
* <p>
* The default value is <code>null</code>, which results in the auto-detection of the most appropriate logging mechanism according to the following algorithm:
* <p>
* <ol>
* <li>If the class <code>org.slf4j.impl.StaticLoggerBinder</code> is detected:
* <ul>
* <li>If the class <code>org.slf4j.impl.JDK14LoggerFactory</code> is detected, use {@link LoggerProvider#JAVA}.
* <li>If the class <code>org.slf4j.impl.Log4jLoggerFactory</code> is detected, use {@link LoggerProvider#LOG4J}.
* <li>If the class <code>org.slf4j.impl.JCLLoggerFactory</code> is NOT detected, use {@link LoggerProvider#SLF4J}.
* </ul>
* <li>If the class <code>org.apache.commons.logging.Log</code> is detected:
* <blockquote>
* Create an instance of it using the commons-logging <code>LogFactory</code> class.
* <ul>
* <li>If the created <code>Log</code> is of type <code>org.apache.commons.logging.impl.Jdk14Logger</code>, use {@link LoggerProvider#JAVA}.
* <li>If the created <code>Log</code> is of type <code>org.apache.commons.logging.impl.Log4JLogger</code>, use {@link LoggerProvider#LOG4J}.
* <li>otherwise, use {@link LoggerProvider#JCL}.
* </ul>
* </blockquote>
* <li>If the class <code>org.apache.log4j.Logger</code> is detected, use {@link LoggerProvider#LOG4J}.
* <li>otherwise, use {@link LoggerProvider#JAVA}.
* </ol>
*
* @see Source#setLogger(Logger)
*/
public static LoggerProvider LoggerProvider=null;
/**
* Determines the string used to represent a <a target="_blank" href="http://en.wikipedia.org/wiki/Newline">newline</a> in text output throughout the library.
* <p>
* The default value is the standard new line character sequence of the host platform, determined by <code>System.getProperty("line.separator")</code>.
*/
public static String NewLine=System.getProperty("line.separator");
/**
* Used in Element.getChildElements.
* Server elements containing markup should be included in the hierarchy, so consider making this option public in future.
*/
static final boolean IncludeServerTagsInElementHierarchy=false;
/**
* Represents a set of maximum unicode code points to be recognised for the three types of
* <a href="CharacterReference.html#Unterminated">unterminated</a> character reference in a given context.
* <p>
* The three types of character reference are:
* <ul>
* <li>{@linkplain CharacterEntityReference Character entity reference}
* <li><a href="NumericCharacterReference.html#DecimalCharacterReference">Decimal character reference</a>
* <li><a href="NumericCharacterReference.html#HexadecimalCharacterReference">Hexadecimal character reference</a>
* </ul>
* <p>
* The two types of contexts used in this library are:
* <ul>
* <li>Inside an attribute value
* <li>Outside an attribute value
* </ul>
*/
static class UnterminatedCharacterReferenceSettings {
// use volatile fields to make them thread safe
public volatile int characterEntityReferenceMaxCodePoint;
public volatile int decimalCharacterReferenceMaxCodePoint;
public volatile int hexadecimalCharacterReferenceMaxCodePoint;
public static UnterminatedCharacterReferenceSettings ACCEPT_ALL=new UnterminatedCharacterReferenceSettings(CompatibilityMode.CODE_POINTS_ALL,CompatibilityMode.CODE_POINTS_ALL,CompatibilityMode.CODE_POINTS_ALL);
public UnterminatedCharacterReferenceSettings() {
this(CompatibilityMode.CODE_POINTS_NONE,CompatibilityMode.CODE_POINTS_NONE,CompatibilityMode.CODE_POINTS_NONE);
}
public UnterminatedCharacterReferenceSettings(final int characterEntityReferenceMaxCodePoint, final int decimalCharacterReferenceMaxCodePoint, final int hexadecimalCharacterReferenceMaxCodePoint) {
this.characterEntityReferenceMaxCodePoint=characterEntityReferenceMaxCodePoint;
this.decimalCharacterReferenceMaxCodePoint=decimalCharacterReferenceMaxCodePoint;
this.hexadecimalCharacterReferenceMaxCodePoint=hexadecimalCharacterReferenceMaxCodePoint;
}
public String toString() {
return Config.NewLine+" Character entity reference: "+getDescription(characterEntityReferenceMaxCodePoint)
+Config.NewLine+" Decimal character reference: "+getDescription(decimalCharacterReferenceMaxCodePoint)
+Config.NewLine+" Haxadecimal character reference: "+getDescription(hexadecimalCharacterReferenceMaxCodePoint);
}
private String getDescription(final int codePoint) {
if (codePoint==CompatibilityMode.CODE_POINTS_NONE) return "None";
if (codePoint==CompatibilityMode.CODE_POINTS_ALL) return "All";
return "0x"+Integer.toString(codePoint,16);
}
}
/**
* Represents a set of configuration parameters that relate to
* <a target="_blank" href="http://www.w3.org/TR/html401/conform.html#didx-user_agent">user agent</a> compatibility issues.
* <p>
* The predefined compatibility modes {@link #IE}, {@link #MOZILLA}, {@link #OPERA} and {@link #XHTML} provide an easy means of
* ensuring the library interprets the markup in a way consistent with some of the most commonly used browsers,
* at least in relation to the behaviour described by the properties in this class.
* <p>
* The properties of any <code>CompatibilityMode</code> object can be modified individually, including those in
* the predefined instances as well as newly constructed instances.
* Take note however that modifying the properties of the predefined instances has a global affect.
* <p>
* The currently active compatibility mode is stored in the static {@link Config#CurrentCompatibilityMode} property.
* <p>
*/
public static final class CompatibilityMode {
private String name;
private volatile boolean formFieldNameCaseInsensitive;
volatile UnterminatedCharacterReferenceSettings unterminatedCharacterReferenceSettingsInsideAttributeValue;
volatile UnterminatedCharacterReferenceSettings unterminatedCharacterReferenceSettingsOutsideAttributeValue;
/**
* Indicates the recognition of all unicode code points.
* <p>
* This value is used in properties which specify a maximum unicode code point to be recognised by the parser.
*
* @see #getUnterminatedCharacterEntityReferenceMaxCodePoint(boolean insideAttributeValue)
* @see #getUnterminatedDecimalCharacterReferenceMaxCodePoint(boolean insideAttributeValue)
* @see #getUnterminatedHexadecimalCharacterReferenceMaxCodePoint(boolean insideAttributeValue)
*/
public static final int CODE_POINTS_ALL=Character.MAX_CODE_POINT; // 0x10FFFF (decimal 1114111)
/**
* Indicates the recognition of no unicode code points.
* <p>
* This value is used in properties which specify a maximum unicode code point to be recognised by the parser.
*
* @see #getUnterminatedCharacterEntityReferenceMaxCodePoint(boolean insideAttributeValue)
* @see #getUnterminatedDecimalCharacterReferenceMaxCodePoint(boolean insideAttributeValue)
* @see #getUnterminatedHexadecimalCharacterReferenceMaxCodePoint(boolean insideAttributeValue)
*/
public static final int CODE_POINTS_NONE=CharacterReference.INVALID_CODE_POINT;
/**
* <a target="_blank" href="http://www.microsoft.com/windows/ie/">Microsoft Internet Explorer</a> compatibility mode.
* <p>
* <code>{@link #getName() Name} = IE</code><br />
* <code>{@link #isFormFieldNameCaseInsensitive() FormFieldNameCaseInsensitive} = true</code><br />
* <table cellspacing="0" cellpadding="0">
* <tr><th>Recognition of unterminated character references:<th><th align="center"> (inside attribute) <th align="center"> (outside attribute)
* <tr><td>{@link #getUnterminatedCharacterEntityReferenceMaxCodePoint(boolean) UnterminatedCharacterEntityReferenceMaxCodePoint}<td><code> =</code><td align="center">U+00FF<td align="center">U+00FF
* <tr><td>{@link #getUnterminatedDecimalCharacterReferenceMaxCodePoint(boolean) UnterminatedDecimalCharacterReferenceMaxCodePoint}<td><code> =</code><td align="center">{@linkplain #CODE_POINTS_ALL All}<td align="center">{@linkplain #CODE_POINTS_ALL All}
* <tr><td>{@link #getUnterminatedHexadecimalCharacterReferenceMaxCodePoint(boolean) UnterminatedHexadecimalCharacterReferenceMaxCodePoint}<td><code> =</code><td align="center">{@linkplain #CODE_POINTS_ALL All}<td align="center">{@linkplain #CODE_POINTS_NONE None}
* </table>
*/
public static final CompatibilityMode IE=new CompatibilityMode("IE",true,
new UnterminatedCharacterReferenceSettings(0xFF, CODE_POINTS_ALL, CODE_POINTS_ALL), // inside attributes
new UnterminatedCharacterReferenceSettings(0xFF, CODE_POINTS_ALL, CODE_POINTS_NONE) // outside attributes
);
/**
* <a target="_blank" href="http://www.mozilla.org/products/mozilla1.x/">Mozilla</a> /
* <a target="_blank" href="http://www.mozilla.org/products/firefox/">Firefox</a> /
* <a target="_blank" href="http://browser.netscape.com/">Netscape</a> compatibility mode.
* <p>
* <code>{@link #getName() Name} = Mozilla</code><br />
* <code>{@link #isFormFieldNameCaseInsensitive() FormFieldNameCaseInsensitive} = false</code><br />
* <table cellspacing="0" cellpadding="0">
* <tr><th>Recognition of unterminated character references:<th><th align="center"> (inside attribute) <th align="center"> (outside attribute)
* <tr><td>{@link #getUnterminatedCharacterEntityReferenceMaxCodePoint(boolean) UnterminatedCharacterEntityReferenceMaxCodePoint}<td><code> =</code><td align="center">U+00FF<td align="center">{@linkplain #CODE_POINTS_ALL All}
* <tr><td>{@link #getUnterminatedDecimalCharacterReferenceMaxCodePoint(boolean) UnterminatedDecimalCharacterReferenceMaxCodePoint}<td><code> =</code><td align="center">{@linkplain #CODE_POINTS_ALL All}<td align="center">{@linkplain #CODE_POINTS_ALL All}
* <tr><td>{@link #getUnterminatedHexadecimalCharacterReferenceMaxCodePoint(boolean) UnterminatedHexadecimalCharacterReferenceMaxCodePoint}<td><code> =</code><td align="center">{@linkplain #CODE_POINTS_ALL All}<td align="center">{@linkplain #CODE_POINTS_ALL All}
* </table>
*/
public static final CompatibilityMode MOZILLA=new CompatibilityMode("Mozilla",false,
new UnterminatedCharacterReferenceSettings(0xFF, CODE_POINTS_ALL, CODE_POINTS_ALL), // inside attributes
new UnterminatedCharacterReferenceSettings(CODE_POINTS_ALL, CODE_POINTS_ALL, CODE_POINTS_ALL) // outside attributes
);
/**
* Opera compatibility mode.
* <p>
* <code>{@link #getName() Name} = Opera</code><br />
* <code>{@link #isFormFieldNameCaseInsensitive() FormFieldNameCaseInsensitive} = true</code><br />
* <table cellspacing="0" cellpadding="0">
* <tr><th>Recognition of unterminated character references:<th><th align="center"> (inside attribute) <th align="center"> (outside attribute)
* <tr><td>{@link #getUnterminatedCharacterEntityReferenceMaxCodePoint(boolean) UnterminatedCharacterEntityReferenceMaxCodePoint}<td><code> =</code><td align="center">U+003E<td align="center">{@linkplain #CODE_POINTS_ALL All}
* <tr><td>{@link #getUnterminatedDecimalCharacterReferenceMaxCodePoint(boolean) UnterminatedDecimalCharacterReferenceMaxCodePoint}<td><code> =</code><td align="center">{@linkplain #CODE_POINTS_ALL All}<td align="center">{@linkplain #CODE_POINTS_ALL All}
* <tr><td>{@link #getUnterminatedHexadecimalCharacterReferenceMaxCodePoint(boolean) UnterminatedHexadecimalCharacterReferenceMaxCodePoint}<td><code> =</code><td align="center">{@linkplain #CODE_POINTS_ALL All}<td align="center">{@linkplain #CODE_POINTS_ALL All}
* </table>
*/
public static final CompatibilityMode OPERA=new CompatibilityMode("Opera",true,
new UnterminatedCharacterReferenceSettings(0x3E, CODE_POINTS_ALL, CODE_POINTS_ALL), // inside attributes
new UnterminatedCharacterReferenceSettings(CODE_POINTS_ALL, CODE_POINTS_ALL, CODE_POINTS_ALL) // outside attributes
);
/**
* <a target="_blank" href="http://www.w3.org/TR/xhtml1/#xhtml">XHTML</a> compatibility mode.
* <p>
* <code>{@link #getName() Name} = XHTML</code><br />
* <code>{@link #isFormFieldNameCaseInsensitive() FormFieldNameCaseInsensitive} = false</code><br />
* <table cellspacing="0" cellpadding="0">
* <tr><th>Recognition of unterminated character references:<th><th align="center"> (inside attribute) <th align="center"> (outside attribute)
* <tr><td>{@link #getUnterminatedCharacterEntityReferenceMaxCodePoint(boolean) UnterminatedCharacterEntityReferenceMaxCodePoint}<td><code> =</code><td align="center">{@linkplain #CODE_POINTS_NONE None}<td align="center">{@linkplain #CODE_POINTS_NONE None}
* <tr><td>{@link #getUnterminatedDecimalCharacterReferenceMaxCodePoint(boolean) UnterminatedDecimalCharacterReferenceMaxCodePoint}<td><code> =</code><td align="center">{@linkplain #CODE_POINTS_NONE None}<td align="center">{@linkplain #CODE_POINTS_NONE None}
* <tr><td>{@link #getUnterminatedHexadecimalCharacterReferenceMaxCodePoint(boolean) UnterminatedHexadecimalCharacterReferenceMaxCodePoint}<td><code> =</code><td align="center">{@linkplain #CODE_POINTS_NONE None}<td align="center">{@linkplain #CODE_POINTS_NONE None}
* </table>
*/
public static final CompatibilityMode XHTML=new CompatibilityMode("XHTML");
/**
* Constructs a new <code>CompatibilityMode</code> with the given {@linkplain #getName() name}.
* <p>
* All properties in the new instance are initially assigned their default values, which are the same as the strict
* rules of the {@link #XHTML} compatibility mode.
*
* @param name the {@linkplain #getName() name} of the new compatibility mode
*/
public CompatibilityMode(final String name) {
this(name,false,new UnterminatedCharacterReferenceSettings(),new UnterminatedCharacterReferenceSettings());
}
private CompatibilityMode(final String name, final boolean formFieldNameCaseInsensitive, final UnterminatedCharacterReferenceSettings unterminatedCharacterReferenceSettingsInsideAttributeValue, final UnterminatedCharacterReferenceSettings unterminatedCharacterReferenceSettingsOutsideAttributeValue) {
this.name=name;
this.formFieldNameCaseInsensitive=formFieldNameCaseInsensitive;
this.unterminatedCharacterReferenceSettingsInsideAttributeValue=unterminatedCharacterReferenceSettingsInsideAttributeValue;
this.unterminatedCharacterReferenceSettingsOutsideAttributeValue=unterminatedCharacterReferenceSettingsOutsideAttributeValue;
}
/**
* Returns the name of this compatibility mode.
* @return the name of this compatibility mode.
*/
public String getName() {
return name;
}
/**
* Indicates whether {@linkplain FormField#getName() form field names} are treated as case insensitive.
* <p>
* Microsoft Internet Explorer treats field names as case insensitive,
* while Mozilla treats them as case sensitive.
* <p>
* The value of this property in the {@linkplain Config#CurrentCompatibilityMode current compatibility mode}
* affects all instances of the {@link FormFields} class.
* It should be set to the desired configuration before any instances of <code>FormFields</code> are created.
*
* @return <code>true</code> if {@linkplain FormField#getName() form field names} are treated as case insensitive, otherwise <code>false</code>.
* @see #setFormFieldNameCaseInsensitive(boolean)
*/
public boolean isFormFieldNameCaseInsensitive() {
return formFieldNameCaseInsensitive;
}
/**
* Sets whether {@linkplain FormField#getName() form field names} are treated as case insensitive.
* <p>
* See {@link #isFormFieldNameCaseInsensitive()} for the documentation of this property.
*
* @param value the new value of the property
*/
public void setFormFieldNameCaseInsensitive(final boolean value) {
formFieldNameCaseInsensitive=value;
}
/**
* Returns the maximum unicode code point of an <a href="CharacterReference.html#Unterminated">unterminated</a>
* {@linkplain CharacterEntityReference character entity reference} which is to be recognised in the specified context.
* <p>
* For example, if <code>getUnterminatedCharacterEntityReferenceMaxCodePoint(true)</code> has the value <code>0xFF</code> (U+00FF)
* in the {@linkplain Config#CurrentCompatibilityMode current compatibility mode}, then:
* <ul>
* <li>{@link CharacterReference#decode(CharSequence,boolean) CharacterReference.decode(">",true)}
* returns "<code>></code>".<br />
* The string is recognised as the character entity reference {@link CharacterEntityReference#_gt >}
* despite the fact that it is <a href="CharacterReference.html#Unterminated">unterminated</a>,
* because its unicode code point U+003E is below the maximum of U+00FF set by this property.
* <li>{@link CharacterReference#decode(CharSequence,boolean) CharacterReference.decode("&euro",true)}
* returns "<code>&euro</code>".<br />
* The string is not recognised as the character entity reference {@link CharacterEntityReference#_euro €}
* because it is <a href="CharacterReference.html#Unterminated">unterminated</a>
* and its unicode code point U+20AC is above the maximum of U+00FF set by this property.
* </ul>
* <p>
* See the documentation of the {@link Attribute#getValue()} method for further discussion.
*
* @param insideAttributeValue the context within an HTML document - <code>true</code> if inside an attribute value or <code>false</code> if outside an attribute value.
* @return the maximum unicode code point of an <a href="CharacterReference.html#Unterminated">unterminated</a> {@linkplain CharacterEntityReference character entity reference} which is to be recognised in the specified context.
* @see #setUnterminatedCharacterEntityReferenceMaxCodePoint(boolean insideAttributeValue, int maxCodePoint)
*/
public int getUnterminatedCharacterEntityReferenceMaxCodePoint(final boolean insideAttributeValue) {
return getUnterminatedCharacterReferenceSettings(insideAttributeValue).characterEntityReferenceMaxCodePoint;
}
/**
* Sets the maximum unicode code point of an <a href="CharacterReference.html#Unterminated">unterminated</a>
* {@linkplain CharacterEntityReference character entity reference} which is to be recognised in the specified context.
* <p>
* See {@link #getUnterminatedCharacterEntityReferenceMaxCodePoint(boolean insideAttributeValue)} for the documentation of this property.
*
* @param insideAttributeValue the context within an HTML document - <code>true</code> if inside an attribute value or <code>false</code> if outside an attribute value.
* @param maxCodePoint the maximum unicode code point.
*/
public void setUnterminatedCharacterEntityReferenceMaxCodePoint(final boolean insideAttributeValue, final int maxCodePoint) {
getUnterminatedCharacterReferenceSettings(insideAttributeValue).characterEntityReferenceMaxCodePoint=maxCodePoint;
}
/**
* Returns the maximum unicode code point of an <a href="CharacterReference.html#Unterminated">unterminated</a>
* <a href="NumericCharacterReference.html#DecimalCharacterReference">decimal character reference</a> which is to be recognised in the specified context.
* <p>
* For example, if <code>getUnterminatedDecimalCharacterReferenceMaxCodePoint(true)</code> had the hypothetical value <code>0xFF</code> (U+00FF)
* in the {@linkplain Config#CurrentCompatibilityMode current compatibility mode}, then:
* <ul>
* <li>{@link CharacterReference#decode(CharSequence,boolean) CharacterReference.decode(">",true)}
* returns "<code>></code>".<br />
* The string is recognised as the numeric character reference <code>></code>
* despite the fact that it is <a href="CharacterReference.html#Unterminated">unterminated</a>,
* because its unicode code point U+003E is below the maximum of U+00FF set by this property.
* <li>{@link CharacterReference#decode(CharSequence,boolean) CharacterReference.decode("€",true)}
* returns "<code>€</code>".<br />
* The string is not recognised as the numeric character reference <code>€</code>
* because it is <a href="CharacterReference.html#Unterminated">unterminated</a>
* and its unicode code point U+20AC is above the maximum of U+00FF set by this property.
* </ul>
*
* @param insideAttributeValue the context within an HTML document - <code>true</code> if inside an attribute value or <code>false</code> if outside an attribute value.
* @return the maximum unicode code point of an <a href="CharacterReference.html#Unterminated">unterminated</a> <a href="NumericCharacterReference.html#DecimalCharacterReference">decimal character reference</a> which is to be recognised in the specified context.
* @see #setUnterminatedDecimalCharacterReferenceMaxCodePoint(boolean insideAttributeValue, int maxCodePoint)
*/
public int getUnterminatedDecimalCharacterReferenceMaxCodePoint(final boolean insideAttributeValue) {
return getUnterminatedCharacterReferenceSettings(insideAttributeValue).decimalCharacterReferenceMaxCodePoint;
}
/**
* Sets the maximum unicode code point of an <a href="CharacterReference.html#Unterminated">unterminated</a>
* <a href="NumericCharacterReference.html#DecimalCharacterReference">decimal character reference</a> which is to be recognised in the specified context.
* <p>
* See {@link #getUnterminatedDecimalCharacterReferenceMaxCodePoint(boolean insideAttributeValue)} for the documentation of this property.
*
* @param insideAttributeValue the context within an HTML document - <code>true</code> if inside an attribute value or <code>false</code> if outside an attribute value.
* @param maxCodePoint the maximum unicode code point.
*/
public void setUnterminatedDecimalCharacterReferenceMaxCodePoint(final boolean insideAttributeValue, final int maxCodePoint) {
getUnterminatedCharacterReferenceSettings(insideAttributeValue).decimalCharacterReferenceMaxCodePoint=maxCodePoint;
}
/**
* Returns the maximum unicode code point of an <a href="CharacterReference.html#Unterminated">unterminated</a>
* <a href="NumericCharacterReference.html#HexadecimalCharacterReference">hexadecimal character reference</a> which is to be recognised in the specified context.
* <p>
* For example, if <code>getUnterminatedHexadecimalCharacterReferenceMaxCodePoint(true)</code> had the hypothetical value <code>0xFF</code> (U+00FF)
* in the {@linkplain Config#CurrentCompatibilityMode current compatibility mode}, then:
* <ul>
* <li>{@link CharacterReference#decode(CharSequence,boolean) CharacterReference.decode(">",true)}
* returns "<code>></code>".<br />
* The string is recognised as the numeric character reference <code>></code>
* despite the fact that it is <a href="CharacterReference.html#Unterminated">unterminated</a>,
* because its unicode code point U+003E is below the maximum of U+00FF set by this property.
* <li>{@link CharacterReference#decode(CharSequence,boolean) CharacterReference.decode("€",true)}
* returns "<code>€</code>".<br />
* The string is not recognised as the numeric character reference <code>ac;</code>
* because it is <a href="CharacterReference.html#Unterminated">unterminated</a>
* and its unicode code point U+20AC is above the maximum of U+00FF set by this property.
* </ul>
*
* @param insideAttributeValue the context within an HTML document - <code>true</code> if inside an attribute value or <code>false</code> if outside an attribute value.
* @return the maximum unicode code point of an <a href="CharacterReference.html#Unterminated">unterminated</a> <a href="NumericCharacterReference.html#HexadecimalCharacterReference">hexadecimal character reference</a> which is to be recognised in the specified context.
* @see #setUnterminatedHexadecimalCharacterReferenceMaxCodePoint(boolean insideAttributeValue, int maxCodePoint)
*/
public int getUnterminatedHexadecimalCharacterReferenceMaxCodePoint(final boolean insideAttributeValue) {
return getUnterminatedCharacterReferenceSettings(insideAttributeValue).hexadecimalCharacterReferenceMaxCodePoint;
}
/**
* Sets the maximum unicode code point of an <a href="CharacterReference.html#Unterminated">unterminated</a>
* <a href="NumericCharacterReference.html#HexadecimalCharacterReference">headecimal character reference</a> which is to be recognised in the specified context.
* <p>
* See {@link #getUnterminatedHexadecimalCharacterReferenceMaxCodePoint(boolean insideAttributeValue)} for the documentation of this property.
*
* @param insideAttributeValue the context within an HTML document - <code>true</code> if inside an attribute value or <code>false</code> if outside an attribute value.
* @param maxCodePoint the maximum unicode code point.
*/
public void setUnterminatedHexadecimalCharacterReferenceMaxCodePoint(final boolean insideAttributeValue, final int maxCodePoint) {
getUnterminatedCharacterReferenceSettings(insideAttributeValue).hexadecimalCharacterReferenceMaxCodePoint=maxCodePoint;
}
/**
* Returns a string representation of this object useful for debugging purposes.
* @return a string representation of this object useful for debugging purposes.
*/
public String getDebugInfo() {
return "Form field name case insensitive: "+formFieldNameCaseInsensitive
+Config.NewLine+"Maximum codepoints in unterminated character references:"
+Config.NewLine+" Inside attribute values:"
+unterminatedCharacterReferenceSettingsInsideAttributeValue
+Config.NewLine+" Outside attribute values:"
+unterminatedCharacterReferenceSettingsOutsideAttributeValue;
}
/**
* Returns the {@linkplain #getName() name} of this compatibility mode.
* @return the {@linkplain #getName() name} of this compatibility mode.
*/
public String toString() {
return getName();
}
UnterminatedCharacterReferenceSettings getUnterminatedCharacterReferenceSettings(final boolean insideAttributeValue) {
return insideAttributeValue ? unterminatedCharacterReferenceSettingsInsideAttributeValue : unterminatedCharacterReferenceSettingsOutsideAttributeValue;
}
}
}