duke@1: /* jjg@1746: * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@1: * duke@1: * This code is free software; you can redistribute it and/or modify it duke@1: * under the terms of the GNU General Public License version 2 only, as ohair@554: * published by the Free Software Foundation. Oracle designates this duke@1: * particular file as subject to the "Classpath" exception as provided ohair@554: * by Oracle in the LICENSE file that accompanied this code. duke@1: * duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@1: * version 2 for more details (a copy is included in the LICENSE file that duke@1: * accompanied this code). duke@1: * duke@1: * You should have received a copy of the GNU General Public License version duke@1: * 2 along with this work; if not, write to the Free Software Foundation, duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@1: * ohair@554: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA ohair@554: * or visit www.oracle.com if you need additional information or have any ohair@554: * questions. duke@1: */ duke@1: duke@1: package com.sun.tools.doclets.internal.toolkit.taglets; duke@1: jjg@1357: import java.util.*; jjg@1357: duke@1: import com.sun.javadoc.*; jjg@1746: import com.sun.tools.doclets.formats.html.markup.StringContent; duke@1: import com.sun.tools.doclets.internal.toolkit.Configuration; duke@1: import com.sun.tools.doclets.internal.toolkit.util.*; duke@1: duke@1: /** duke@1: * An inline Taglet representing the value tag. This tag should only be used with duke@1: * constant fields that have a value. It is used to access the value of constant duke@1: * fields. This inline tag has an optional field name parameter. If the name is duke@1: * specified, the constant value is retrieved from the specified field. A link duke@1: * is also created to the specified field. If a name is not specified, the value duke@1: * is retrieved for the field that the inline tag appears on. The name is specifed duke@1: * in the following format: [fully qualified class name]#[constant field name]. duke@1: * jjg@1359: *
This is NOT part of any supported API.
jjg@1359: * If you write code that depends on this, you do so at your own risk.
jjg@1359: * This code and its internal interfaces are subject to change or
jjg@1359: * deletion without notice.
duke@1: *
duke@1: * @author Jamie Ho
duke@1: * @since 1.4
duke@1: */
duke@1:
duke@1: public class ValueTaglet extends BaseInlineTaglet {
duke@1:
duke@1: /**
duke@1: * Construct a new ValueTaglet.
duke@1: */
duke@1: public ValueTaglet() {
duke@1: name = "value";
duke@1: }
duke@1:
duke@1: /**
duke@1: * Will return false because this inline tag may
duke@1: * only appear in Fields.
duke@1: * @return false since this is not a method.
duke@1: */
duke@1: public boolean inMethod() {
duke@1: return true;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Will return false because this inline tag may
duke@1: * only appear in Fields.
duke@1: * @return false since this is not a method.
duke@1: */
duke@1: public boolean inConstructor() {
duke@1: return true;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Will return false because this inline tag may
duke@1: * only appear in Fields.
duke@1: * @return false since this is not a method.
duke@1: */
duke@1: public boolean inOverview() {
duke@1: return true;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Will return false because this inline tag may
duke@1: * only appear in Fields.
duke@1: * @return false since this is not a method.
duke@1: */
duke@1: public boolean inPackage() {
duke@1: return true;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Will return false because this inline tag may
duke@1: * only appear in Fields.
duke@1: * @return false since this is not a method.
duke@1: */
duke@1: public boolean inType() {
duke@1: return true;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Given the name of the field, return the corresponding FieldDoc.
duke@1: *
duke@1: * @param config the current configuration of the doclet.
duke@1: * @param tag the value tag.
duke@1: * @param name the name of the field to search for. The name should be in
jjg@1358: * {@code