1 /*

     2  * Copyright (c) 2011, 2014, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 package com.sun.source.doctree;

    27 

    28 import java.util.List;

    29 import javax.lang.model.element.Name;

    30 

    31 /**

    32  * A tree node for an attribute in an HTML element.

    33  *

    34  * @since 1.8

    35  */

    36 public interface AttributeTree extends DocTree {

    37     /**

    38      * The kind of an attribute value.

    39      */

    40     enum ValueKind {

    41         /** The attribute value is empty. */

    42         EMPTY,

    43         /** The attribute value is not enclosed in quotes. */

    44         UNQUOTED,

    45         /** The attribute value is enclosed in single quotation marks. */

    46         SINGLE,

    47         /** The attribute value is enclosed in double quotation marks. */

    48         DOUBLE

    49     }

    50 

    51     /**

    52      * Returns the name of the attribute.

    53      * @return the name of the attribute

    54      */

    55     Name getName();

    56 

    57     /**

    58      * Returns the kind of the attribute.

    59      * @return the kind of the attribute.

    60      */

    61     ValueKind getValueKind();

    62 

    63     /**

    64      * Returns the value of the attribute, or {@code null} if the kind is EMPTY.

    65      * @return the value of the attribute.

    66      */

    67     List<? extends DocTree> getValue();

    68 }