aoqi@0: /*
aoqi@0:  * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.doclets.formats.html;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Enum representing various section names of generated API documentation.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Bhavesh Patel
aoqi@0:  */
aoqi@0: public enum SectionName {
aoqi@0: 
aoqi@0:     ANNOTATION_TYPE_ELEMENT_DETAIL("annotation.type.element.detail"),
aoqi@0:     ANNOTATION_TYPE_FIELD_DETAIL("annotation.type.field.detail"),
aoqi@0:     ANNOTATION_TYPE_FIELD_SUMMARY("annotation.type.field.summary"),
aoqi@0:     ANNOTATION_TYPE_OPTIONAL_ELEMENT_SUMMARY("annotation.type.optional.element.summary"),
aoqi@0:     ANNOTATION_TYPE_REQUIRED_ELEMENT_SUMMARY("annotation.type.required.element.summary"),
aoqi@0:     CONSTRUCTOR_DETAIL("constructor.detail"),
aoqi@0:     CONSTRUCTOR_SUMMARY("constructor.summary"),
aoqi@0:     ENUM_CONSTANT_DETAIL("enum.constant.detail"),
aoqi@0:     ENUM_CONSTANTS_INHERITANCE("enum.constants.inherited.from.class."),
aoqi@0:     ENUM_CONSTANT_SUMMARY("enum.constant.summary"),
aoqi@0:     FIELD_DETAIL("field.detail"),
aoqi@0:     FIELDS_INHERITANCE("fields.inherited.from.class."),
aoqi@0:     FIELD_SUMMARY("field.summary"),
aoqi@0:     METHOD_DETAIL("method.detail"),
aoqi@0:     METHODS_INHERITANCE("methods.inherited.from.class."),
aoqi@0:     METHOD_SUMMARY("method.summary"),
aoqi@0:     NAVBAR_BOTTOM("navbar.bottom"),
aoqi@0:     NAVBAR_BOTTOM_FIRSTROW("navbar.bottom.firstrow"),
aoqi@0:     NAVBAR_TOP("navbar.top"),
aoqi@0:     NAVBAR_TOP_FIRSTROW("navbar.top.firstrow"),
aoqi@0:     NESTED_CLASSES_INHERITANCE("nested.classes.inherited.from.class."),
aoqi@0:     NESTED_CLASS_SUMMARY("nested.class.summary"),
aoqi@0:     OVERVIEW_DESCRIPTION("overview.description"),
aoqi@0:     PACKAGE_DESCRIPTION("package.description"),
aoqi@0:     PROPERTY_DETAIL("property.detail"),
aoqi@0:     PROPERTIES_INHERITANCE("properties.inherited.from.class."),
aoqi@0:     PROPERTY_SUMMARY("property.summary"),
aoqi@0:     SKIP_NAVBAR_BOTTOM("skip.navbar.bottom"),
aoqi@0:     SKIP_NAVBAR_TOP("skip.navbar.top"),
aoqi@0:     UNNAMED_PACKAGE_ANCHOR("unnamed.package");
aoqi@0: 
aoqi@0:     private final String value;
aoqi@0: 
aoqi@0:     SectionName(String sName) {
aoqi@0:         this.value = sName;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public String getName() {
aoqi@0:         return this.value;
aoqi@0:     }
aoqi@0: }