1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/TextTag.java Wed Apr 27 01:34:52 2016 +0800
1.3 @@ -0,0 +1,110 @@
1.4 +/*
1.5 + * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +package com.sun.tools.doclets.internal.toolkit.util;
1.29 +import com.sun.javadoc.*;
1.30 +
1.31 +
1.32 +/**
1.33 + * A tag that holds nothing but plain text. This is useful for passing
1.34 + * text to methods that only accept inline tags as a parameter.
1.35 + *
1.36 + * <p><b>This is NOT part of any supported API.
1.37 + * If you write code that depends on this, you do so at your own risk.
1.38 + * This code and its internal interfaces are subject to change or
1.39 + * deletion without notice.</b>
1.40 + *
1.41 + * @author Jamie Ho
1.42 + * @since 1.5
1.43 + */
1.44 +public class TextTag implements Tag {
1.45 + protected final String text;
1.46 + protected final String name = "Text";
1.47 + protected final Doc holder;
1.48 +
1.49 + /**
1.50 + * Constructor
1.51 + */
1.52 + public TextTag(Doc holder, String text) {
1.53 + super();
1.54 + this.holder = holder;
1.55 + this.text = text;
1.56 + }
1.57 +
1.58 + /**
1.59 + * {@inheritDoc}
1.60 + */
1.61 + public String name() {
1.62 + return name;
1.63 + }
1.64 +
1.65 + /**
1.66 + * {@inheritDoc}
1.67 + */
1.68 + public Doc holder() {
1.69 + return holder;
1.70 + }
1.71 +
1.72 + /**
1.73 + * {@inheritDoc}
1.74 + */
1.75 + public String kind() {
1.76 + return name;
1.77 + }
1.78 +
1.79 + /**
1.80 + * {@inheritDoc}
1.81 + */
1.82 + public String text() {
1.83 + return text;
1.84 + }
1.85 +
1.86 + /**
1.87 + * {@inheritDoc}
1.88 + */
1.89 + public String toString() {
1.90 + return name + ":" + text;
1.91 + }
1.92 +
1.93 + /**
1.94 + * {@inheritDoc}
1.95 + */
1.96 + public Tag[] inlineTags() {
1.97 + return new Tag[] {this};
1.98 + }
1.99 +
1.100 + /**
1.101 + * {@inheritDoc}
1.102 + */
1.103 + public Tag[] firstSentenceTags() {
1.104 + return new Tag[] {this};
1.105 + }
1.106 +
1.107 + /**
1.108 + * {@inheritDoc}
1.109 + */
1.110 + public SourcePosition position() {
1.111 + return holder.position();
1.112 + }
1.113 +}
