src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ConstantsSummaryWriter.java
Print this page
*** 1,7 ****
/*
! * Copyright (c) 2003, 2015, Oracle and/or its affiliates. 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. Oracle designates this
--- 1,7 ----
/*
! * Copyright (c) 2003, 2016, Oracle and/or its affiliates. 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. Oracle designates this
*** 21,36 ****
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
! package com.sun.tools.doclets.internal.toolkit;
import java.io.*;
import java.util.*;
! import com.sun.javadoc.*;
/**
* The interface for writing constants summary output.
*
* <p><b>This is NOT part of any supported API.
--- 21,38 ----
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
! package jdk.javadoc.internal.doclets.toolkit;
import java.io.*;
import java.util.*;
! import javax.lang.model.element.PackageElement;
! import javax.lang.model.element.TypeElement;
! import javax.lang.model.element.VariableElement;
/**
* The interface for writing constants summary output.
*
* <p><b>This is NOT part of any supported API.
*** 65,86 ****
public abstract Content getContentsHeader();
/**
* Adds the given package name link to the constant content list tree.
*
! * @param pkg the {@link PackageDoc} to index.
! * @param parsedPackageName the parsed package name. We only Write the
! * first 2 directory levels of the package
! * name. For example, java.lang.ref would be
! * indexed as java.lang.*.
! * @param WriteedPackageHeaders the set of package headers that have already
! * been indexed. We don't want to index
! * something more than once.
* @param contentListTree the content tree to which the link will be added
*/
! public abstract void addLinkToPackageContent(PackageDoc pkg, String parsedPackageName,
! Set<String> WriteedPackageHeaders, Content contentListTree);
/**
* Add the content list to the documentation tree.
*
* @param contentTree the tree to which the contents list will be added
--- 67,83 ----
public abstract Content getContentsHeader();
/**
* Adds the given package name link to the constant content list tree.
*
! * @param pkg the {@link PackageElement} to index.
! * @param writtenPackageHeaders the set of package headers that have already
! * been indexed, we want to index utmost once.
* @param contentListTree the content tree to which the link will be added
*/
! public abstract void addLinkToPackageContent(PackageElement pkg,
! Set<PackageElement> writtenPackageHeaders, Content contentListTree);
/**
* Add the content list to the documentation tree.
*
* @param contentTree the tree to which the contents list will be added
*** 96,114 ****
public abstract Content getConstantSummaries();
/**
* Adds the given package name.
*
! * @param parsedPackageName the parsed package name. We only Write the
* first 2 directory levels of the package
* name. For example, java.lang.ref would be
* indexed as java.lang.*.
* @param summariesTree the summaries documentation tree
* @param first true if the first package is listed
* be written
*/
! public abstract void addPackageName(String parsedPackageName, Content summariesTree, boolean first);
/**
* Get the class summary header for the constants summary.
*
* @return the header content for the class constants summary
--- 93,111 ----
public abstract Content getConstantSummaries();
/**
* Adds the given package name.
*
! * @param pkg the parsed package name. We only Write the
* first 2 directory levels of the package
* name. For example, java.lang.ref would be
* indexed as java.lang.*.
* @param summariesTree the summaries documentation tree
* @param first true if the first package is listed
* be written
*/
! public abstract void addPackageName(PackageElement pkg, Content summariesTree, boolean first);
/**
* Get the class summary header for the constants summary.
*
* @return the header content for the class constants summary
*** 124,139 ****
public abstract void addClassConstant(Content summariesTree, Content classConstantTree);
/**
* Adds the constant member table to the documentation tree.
*
! * @param cd the class whose constants are being documented.
* @param fields the constants being documented.
* @param classConstantTree the documentation tree to which theconstant member
* table content will be added
*/
! public abstract void addConstantMembers(ClassDoc cd, List<FieldDoc> fields,
Content classConstantTree);
/**
* Add the summaries list to the content tree.
*
--- 121,136 ----
public abstract void addClassConstant(Content summariesTree, Content classConstantTree);
/**
* Adds the constant member table to the documentation tree.
*
! * @param typeElement the class whose constants are being documented.
* @param fields the constants being documented.
* @param classConstantTree the documentation tree to which theconstant member
* table content will be added
*/
! public abstract void addConstantMembers(TypeElement typeElement, Collection<VariableElement> fields,
Content classConstantTree);
/**
* Add the summaries list to the content tree.
*