duke@1: /*
ohair@554:  * Copyright (c) 2003, 2005, 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.util.links;
duke@1: 
duke@1: import com.sun.javadoc.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.Configuration;
duke@1: 
duke@1: /**
duke@1:  * Encapsulates information about a link.
duke@1:  *
duke@1:  * @author Jamie Ho
duke@1:  * @since 1.5
duke@1:  */
duke@1: public abstract class LinkInfo {
duke@1: 
duke@1:     /**
duke@1:      * The ClassDoc we want to link to.  Null if we are not linking
duke@1:      * to a ClassDoc.
duke@1:      */
duke@1:     public ClassDoc classDoc;
duke@1: 
duke@1:     /**
duke@1:      * The executable member doc we want to link to.  Null if we are not linking
duke@1:      * to an executable member.
duke@1:      */
duke@1:     public ExecutableMemberDoc executableMemberDoc;
duke@1: 
duke@1:     /**
duke@1:      * The Type we want to link to.  Null if we are not linking to a type.
duke@1:      */
duke@1:     public Type type;
duke@1: 
duke@1:     /**
duke@1:      * True if this is a link to a VarArg.
duke@1:      */
duke@1:     public boolean isVarArg = false;
duke@1: 
duke@1:     /**
duke@1:      * Set this to true to indicate that you are linking to a type parameter.
duke@1:      */
duke@1:     public boolean isTypeBound = false;
duke@1: 
duke@1:     /**
duke@1:      * The label for the link.
duke@1:      */
duke@1:     public String label;
duke@1: 
duke@1:     /**
bpatel@182:      * True if the link should be strong.
duke@1:      */
bpatel@182:     public boolean isStrong = false;
duke@1: 
duke@1:     /**
duke@1:      * True if we should include the type in the link label.  False otherwise.
duke@1:      */
duke@1:     public boolean includeTypeInClassLinkLabel = true;
duke@1: 
duke@1:     /**
duke@1:      * True if we should include the type as seperate link.  False otherwise.
duke@1:      */
duke@1:     public boolean includeTypeAsSepLink = false;
duke@1: 
duke@1:     /**
duke@1:      * True if we should exclude the type bounds for the type parameter.
duke@1:      */
duke@1:     public boolean excludeTypeBounds = false;
duke@1: 
duke@1:     /**
duke@1:      * True if we should print the type parameters, but not link them.
duke@1:      */
duke@1:     public boolean excludeTypeParameterLinks = false;
duke@1: 
duke@1:     /**
duke@1:      * True if we should print the type bounds, but not link them.
duke@1:      */
duke@1:     public boolean excludeTypeBoundsLinks = false;
duke@1: 
duke@1:     /**
duke@1:      * By default, the link can be to the page it's already on.  However,
duke@1:      * there are cases where we don't want this (e.g. heading of class page).
duke@1:      */
duke@1:     public boolean linkToSelf = true;
duke@1: 
duke@1:     /**
duke@1:      * The display length for the link.
duke@1:      */
duke@1:     public int displayLength = 0;
duke@1: 
duke@1:     /**
duke@1:      * Return the id indicating where the link appears in the documentation.
duke@1:      * This is used for special processing of different types of links.
duke@1:      *
duke@1:      * @return the id indicating where the link appears in the documentation.
duke@1:      */
duke@1:     public abstract int getContext();
duke@1: 
duke@1:     /**
duke@1:      * Set the context.
duke@1:      *
duke@1:      * @param c the context id to set.
duke@1:      */
duke@1:     public abstract void setContext(int c);
duke@1: 
duke@1:     /**
duke@1:      * Return true if this link is linkable and false if we can't link to the
duke@1:      * desired place.
duke@1:      *
duke@1:      * @return true if this link is linkable and false if we can't link to the
duke@1:      * desired place.
duke@1:      */
duke@1:     public abstract boolean isLinkable();
duke@1: 
duke@1:     /**
duke@1:      * Return the label for this class link.
duke@1:      *
duke@1:      * @param configuration the current configuration of the doclet.
duke@1:      * @return the label for this class link.
duke@1:      */
duke@1:     public String getClassLinkLabel(Configuration configuration) {
duke@1:         if (label != null && label.length() > 0) {
duke@1:             return label;
duke@1:         } else if (isLinkable()) {
duke@1:             return classDoc.name();
duke@1:         } else {
duke@1:             return configuration.getClassName(classDoc);
duke@1:         }
duke@1:     }
duke@1: }