com.day.cq.rewriter.htmlparser.AttributeList Maven / Gradle / Ivy

/*
 * Copyright 1997-2008 Day Management AG
 * Barfuesserplatz 6, 4001 Basel, Switzerland
 * All Rights Reserved.
 *
 * This software is the confidential and proprietary information of
 * Day Management AG, ("Confidential Information"). You shall not
 * disclose such Confidential Information and shall use it only in
 * accordance with the terms of the license agreement you entered into
 * with Day.
 */
package com.day.cq.rewriter.htmlparser;

import java.util.Iterator;

/**
 * Contains the list of attributes inside an HTML tag.
 * @deprecated This is replaced by the Apache Sling Html parsing.
 */
@Deprecated
public interface AttributeList {

    /**
     * Return the count of attributes
     * @return count of attributes
     */
    int attributeCount();

    /**
     * Return the list of attribute names
     * @return Iterator iterating over the attribute names
     */
    Iterator attributeNames();

    /**
     * Return a flag indicating whether a specified attribute exists
     * @param name name of the attribute
     * @return true if the specified attribute exists,
     * false otherwise
     */
    boolean containsAttribute(String name);

    /**
     * Return an attribute's value, given its name or null
     * if the attribute cannot be found.
     * @param name   attribute name
     * @return an attribute's value
     */
    String getValue(String name);

    /**
     * Return an attribute's quote character, given its name or 0
     * if the attribute cannot be found.
     * @param name   attribute name
     * @return an attribute's quote character
     */
    char getQuoteChar(String name);

    /**
     * Return an attribute's value, already surrounded with the quotes
     * originally in place. Returns null if the attribute
     * cannot be found
     * @param name   attribute name
     * @return an attribute's value
     */
    String getQuotedValue(String name);

    /**
     * Set an attribute's value. If the value is null, this
     * is semantically different to a {@link #removeValue(String)}.
     *
     * @param name      attribute name
     * @param value     attribute value
     */
    void setValue(String name, String value);

    /**
     * Remove an attribute's value.
     * @param name      attribute name
     */
    void removeValue(String name);

    /**
     * Return a flag indicating whether this object was modified.
     * @return true if the object was modified
     *         false otherwise
     */
    boolean isModified();

}