1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/TagletOutput.java Sat Dec 01 00:00:00 2007 +0000
1.3 @@ -0,0 +1,55 @@
1.4 +/*
1.5 + * Copyright 2003 Sun Microsystems, Inc. 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. Sun designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or
1.26 + * have any questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.doclets.internal.toolkit.taglets;
1.30 +
1.31 +/**
1.32 + * The interface for taglet output. This interface is needed because
1.33 + * different doclets work with different formats of output. A single taglet can
1.34 + * work with any doclet that provides an implementation of taglet output.
1.35 + *
1.36 + * @author Jamie Ho
1.37 + * @since 1.5
1.38 + */
1.39 +public interface TagletOutput {
1.40 +
1.41 + /**
1.42 + * Set the output for the taglet.
1.43 + * @param o an object representing the output.
1.44 + */
1.45 + public abstract void setOutput(Object o);
1.46 +
1.47 + /**
1.48 + * Append the given output to this output.
1.49 + * @param o a TagletOutput representing the output.
1.50 + */
1.51 + public abstract void appendOutput(TagletOutput o);
1.52 +
1.53 + /**
1.54 + * Return true if this output has any occurances of @inheritDoc.
1.55 + * @return true if inheritDoc tag is found.
1.56 + */
1.57 + public abstract boolean hasInheritDocTag();
1.58 +}
