diff -r 000000000000 -r 9a66ca7c79fa src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/TagletOutput.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/TagletOutput.java Sat Dec 01 00:00:00 2007 +0000 @@ -0,0 +1,55 @@ +/* + * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Sun designates this + * particular file as subject to the "Classpath" exception as provided + * by Sun in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, + * CA 95054 USA or visit www.sun.com if you need additional information or + * have any questions. + */ + +package com.sun.tools.doclets.internal.toolkit.taglets; + +/** + * The interface for taglet output. This interface is needed because + * different doclets work with different formats of output. A single taglet can + * work with any doclet that provides an implementation of taglet output. + * + * @author Jamie Ho + * @since 1.5 + */ +public interface TagletOutput { + + /** + * Set the output for the taglet. + * @param o an object representing the output. + */ + public abstract void setOutput(Object o); + + /** + * Append the given output to this output. + * @param o a TagletOutput representing the output. + */ + public abstract void appendOutput(TagletOutput o); + + /** + * Return true if this output has any occurances of @inheritDoc. + * @return true if inheritDoc tag is found. + */ + public abstract boolean hasInheritDocTag(); +}