SectionName.java revision 3233:b5d08bc0d224 
1/*
2 * Copyright (c) 2013, 2015, 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
26package jdk.javadoc.internal.doclets.formats.html;
27
28/**
29 * Enum representing various section names of generated API documentation.
30 *
31 *  <p><b>This is NOT part of any supported API.
32 *  If you write code that depends on this, you do so at your own risk.
33 *  This code and its internal interfaces are subject to change or
34 *  deletion without notice.</b>
35 *
36 * @author Bhavesh Patel
37 */
38public enum SectionName {
39
40    ANNOTATION_TYPE_ELEMENT_DETAIL("annotation.type.element.detail"),
41    ANNOTATION_TYPE_FIELD_DETAIL("annotation.type.field.detail"),
42    ANNOTATION_TYPE_FIELD_SUMMARY("annotation.type.field.summary"),
43    ANNOTATION_TYPE_OPTIONAL_ELEMENT_SUMMARY("annotation.type.optional.element.summary"),
44    ANNOTATION_TYPE_REQUIRED_ELEMENT_SUMMARY("annotation.type.required.element.summary"),
45    CONSTRUCTOR_DETAIL("constructor.detail"),
46    CONSTRUCTOR_SUMMARY("constructor.summary"),
47    ENUM_CONSTANT_DETAIL("enum.constant.detail"),
48    ENUM_CONSTANTS_INHERITANCE("enum.constants.inherited.from.class."),
49    ENUM_CONSTANT_SUMMARY("enum.constant.summary"),
50    FIELD_DETAIL("field.detail"),
51    FIELDS_INHERITANCE("fields.inherited.from.class."),
52    FIELD_SUMMARY("field.summary"),
53    METHOD_DETAIL("method.detail"),
54    METHODS_INHERITANCE("methods.inherited.from.class."),
55    METHOD_SUMMARY("method.summary"),
56    NAVBAR_BOTTOM("navbar.bottom"),
57    NAVBAR_BOTTOM_FIRSTROW("navbar.bottom.firstrow"),
58    NAVBAR_TOP("navbar.top"),
59    NAVBAR_TOP_FIRSTROW("navbar.top.firstrow"),
60    NESTED_CLASSES_INHERITANCE("nested.classes.inherited.from.class."),
61    NESTED_CLASS_SUMMARY("nested.class.summary"),
62    OVERVIEW_DESCRIPTION("overview.description"),
63    PACKAGE_DESCRIPTION("package.description"),
64    PROPERTY_DETAIL("property.detail"),
65    PROPERTIES_INHERITANCE("properties.inherited.from.class."),
66    PROPERTY_SUMMARY("property.summary"),
67    SKIP_NAVBAR_BOTTOM("skip.navbar.bottom"),
68    SKIP_NAVBAR_TOP("skip.navbar.top"),
69    UNNAMED_PACKAGE_ANCHOR("unnamed.package");
70
71    private final String value;
72
73    SectionName(String sName) {
74        this.value = sName;
75    }
76
77    public String getName() {
78        return this.value;
79    }
80}
81