com.itextpdf.styledxmlparser.jsoup.nodes.Attribute Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of styled-xml-parser Show documentation
Show all versions of styled-xml-parser Show documentation
Styled XML parser is used by iText modules to parse HTML and XML
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2018 iText Group NV
Authors: iText Software.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License version 3
as published by the Free Software Foundation with the addition of the
following permission added to Section 15 as permitted in Section 7(a):
FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
OF THIRD PARTY RIGHTS
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program; if not, see http://www.gnu.org/licenses or write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA, 02110-1301 USA, or download the license from the following URL:
http://itextpdf.com/terms-of-use/
The interactive user interfaces in modified source and object code versions
of this program must display Appropriate Legal Notices, as required under
Section 5 of the GNU Affero General Public License.
In accordance with Section 7(b) of the GNU Affero General Public License,
a covered work must retain the producer line in every PDF that is created
or manipulated using iText.
You can be released from the requirements of the license by purchasing
a commercial license. Buying such a license is mandatory as soon as you
develop commercial activities involving the iText software without
disclosing the source code of your own applications.
These activities include: offering paid services to customers as an ASP,
serving PDFs on the fly in a web application, shipping iText with a closed
source product.
For more information, please contact iText Software Corp. at this
address: [email protected]
*/
package com.itextpdf.styledxmlparser.jsoup.nodes;
import com.itextpdf.styledxmlparser.jsoup.helper.Validate;
import com.itextpdf.styledxmlparser.jsoup.SerializationException;
import java.io.IOException;
import java.util.Arrays;
import java.util.Map;
/**
A single key + value attribute. Keys are trimmed and normalised to lower-case.
@author Jonathan Hedley, [email protected] */
public class Attribute implements Map.Entry, Cloneable {
private static final String[] booleanAttributes = {
"allowfullscreen", "async", "autofocus", "checked", "compact", "declare", "default", "defer", "disabled",
"formnovalidate", "hidden", "inert", "ismap", "itemscope", "multiple", "muted", "nohref", "noresize",
"noshade", "novalidate", "nowrap", "open", "readonly", "required", "reversed", "seamless", "selected",
"sortable", "truespeed", "typemustmatch"
};
private String key;
private String value;
/**
* Create a new attribute from unencoded (raw) key and value.
* @param key attribute key
* @param value attribute value
* @see #createFromEncoded
*/
public Attribute(String key, String value) {
Validate.notEmpty(key);
Validate.notNull(value);
this.key = key.trim().toLowerCase();
this.value = value;
}
/**
Get the attribute key.
@return the attribute key
*/
public String getKey() {
return key;
}
/**
Set the attribute key. Gets normalised as per the constructor method.
@param key the new key; must not be null
*/
public void setKey(String key) {
Validate.notEmpty(key);
this.key = key.trim().toLowerCase();
}
/**
Get the attribute value.
@return the attribute value
*/
public String getValue() {
return value;
}
/**
Set the attribute value.
@param value the new attribute value; must not be null
*/
public String setValue(String value) {
Validate.notNull(value);
String old = this.value;
this.value = value;
return old;
}
/**
Get the HTML representation of this attribute; e.g. {@code href="index.html"}.
@return HTML
*/
public String html() {
StringBuilder accum = new StringBuilder();
try {
html(accum, (new Document("")).outputSettings());
} catch(IOException exception) {
throw new SerializationException(exception);
}
return accum.toString();
}
protected void html(Appendable accum, Document.OutputSettings out) throws IOException {
accum.append(key);
if (!shouldCollapseAttribute(out)) {
accum.append("=\"");
Entities.escape(accum, value, out, true, false, false);
accum.append('"');
}
}
/**
Get the string representation of this attribute, implemented as {@link #html()}.
@return string
*/
@Override
public String toString() {
return html();
}
/**
* Create a new Attribute from an unencoded key and a HTML attribute encoded value.
* @param unencodedKey assumes the key is not encoded, as can be only run of simple \w chars.
* @param encodedValue HTML attribute encoded value
* @return attribute
*/
public static Attribute createFromEncoded(String unencodedKey, String encodedValue) {
String value = Entities.unescape(encodedValue, true);
return new Attribute(unencodedKey, value);
}
protected boolean isDataAttribute() {
return key.startsWith(Attributes.dataPrefix) && key.length() > Attributes.dataPrefix.length();
}
/**
* Collapsible if it's a boolean attribute and value is empty or same as name
*
* @param out Outputsettings
* @return Returns whether collapsible or not
*/
protected final boolean shouldCollapseAttribute(Document.OutputSettings out) {
return ("".equals(value) || value.equalsIgnoreCase(key))
&& out.syntax() == Document.OutputSettings.Syntax.html
&& isBooleanAttribute();
}
protected boolean isBooleanAttribute() {
return Arrays.binarySearch(booleanAttributes, key) >= 0;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (!(o instanceof Attribute)) return false;
Attribute attribute = (Attribute) o;
if (key != null ? !key.equals(attribute.key) : attribute.key != null) return false;
return !(value != null ? !value.equals(attribute.value) : attribute.value != null);
}
@Override
public int hashCode() {
int result = key != null ? key.hashCode() : 0;
result = 31 * result + (value != null ? value.hashCode() : 0);
return result;
}
@Override
public Object clone() {
try {
return super.clone(); // only fields are immutable strings key and value, so no more deep copy required
} catch (CloneNotSupportedException e) {
throw new RuntimeException(e);
}
}
}