• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/doclets/internal/toolkit/Content.java@694ff82ca68e (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/Content.java

Wed, 13 Apr 2011 11:35:43 -0700

author

jjh

date

Wed, 13 Apr 2011 11:35:43 -0700

changeset 972

694ff82ca68e

parent 819

a466f00c5cd2

child 962

0ff2bbd38f10

permissions

-rw-r--r--

7032975: API files in javax.annotation.processing need to be updated for references to JLS
7032972: API files in javax.tools need to updated for references to JVM Spec with editions/hyperlinks
7032978: API files in javax.tools need to be updated for references to JLS with editions/hyperlinks
Summary: Removed URLs and 'edition' references
Reviewed-by: jjg, darcy

bpatel@766	1	/*
bpatel@766	2	* Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
bpatel@766	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
bpatel@766	4	*
bpatel@766	5	* This code is free software; you can redistribute it and/or modify it
bpatel@766	6	* under the terms of the GNU General Public License version 2 only, as
bpatel@766	7	* published by the Free Software Foundation. Oracle designates this
bpatel@766	8	* particular file as subject to the "Classpath" exception as provided
bpatel@766	9	* by Oracle in the LICENSE file that accompanied this code.
bpatel@766	10	*
bpatel@766	11	* This code is distributed in the hope that it will be useful, but WITHOUT
bpatel@766	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
bpatel@766	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
bpatel@766	14	* version 2 for more details (a copy is included in the LICENSE file that
bpatel@766	15	* accompanied this code).
bpatel@766	16	*
bpatel@766	17	* You should have received a copy of the GNU General Public License version
bpatel@766	18	* 2 along with this work; if not, write to the Free Software Foundation,
bpatel@766	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
bpatel@766	20	*
bpatel@766	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
bpatel@766	22	* or visit www.oracle.com if you need additional information or have any
bpatel@766	23	* questions.
bpatel@766	24	*/
bpatel@766	25
bpatel@766	26	package com.sun.tools.doclets.internal.toolkit;
bpatel@766	27
bpatel@766	28	import com.sun.tools.doclets.internal.toolkit.util.*;
bpatel@766	29
bpatel@766	30	/**
bpatel@766	31	* A class to create content for javadoc output pages.
bpatel@766	32	*
bpatel@766	33	* @author Bhavesh Patel
bpatel@766	34	*/
bpatel@766	35	public abstract class Content {
bpatel@766	36
bpatel@766	37	/**
bpatel@766	38	* Returns a string representation of the content.
bpatel@766	39	*
bpatel@766	40	* @return string representation of the content
bpatel@766	41	*/
bpatel@766	42	public String toString() {
bpatel@766	43	StringBuilder contentBuilder = new StringBuilder();
bpatel@766	44	write(contentBuilder);
bpatel@766	45	return contentBuilder.toString();
bpatel@766	46	}
bpatel@766	47
bpatel@766	48	/**
bpatel@766	49	* Adds content to the existing content.
bpatel@766	50	*
bpatel@766	51	* @param content content that needs to be added
bpatel@766	52	*/
bpatel@766	53	public abstract void addContent(Content content);
bpatel@766	54
bpatel@766	55	/**
bpatel@766	56	* Adds a string content to the existing content.
bpatel@766	57	*
bpatel@766	58	* @param stringContent the string content to be added
bpatel@766	59	*/
bpatel@766	60	public abstract void addContent(String stringContent);
bpatel@766	61
bpatel@766	62	/**
bpatel@766	63	* Writes content to a StringBuilder.
bpatel@766	64	*
bpatel@766	65	*/
bpatel@766	66	public abstract void write(StringBuilder contentBuilder);
bpatel@766	67
bpatel@766	68	/**
bpatel@766	69	* Returns true if the content is empty.
bpatel@766	70	*
bpatel@766	71	* @return true if no content to be displayed else return false
bpatel@766	72	*/
bpatel@766	73	public abstract boolean isEmpty();
bpatel@766	74
bpatel@766	75	/**
bpatel@766	76	* Returns true if the content is valid.
bpatel@766	77	*
bpatel@766	78	* @return true if the content is valid else return false
bpatel@766	79	*/
bpatel@766	80	public boolean isValid() {
bpatel@766	81	return !isEmpty();
bpatel@766	82	}
bpatel@766	83
bpatel@766	84	/**
bpatel@766	85	* Checks for null values.
bpatel@766	86	*
bpatel@766	87	* @param t reference type to check for null values
bpatel@766	88	* @return the reference type if not null or else throws a null pointer exception
bpatel@766	89	*/
bpatel@766	90	protected static <T> T nullCheck(T t) {
bpatel@766	91	t.getClass();
bpatel@766	92	return t;
bpatel@766	93	}
bpatel@766	94
bpatel@766	95	/**
bpatel@766	96	* Returns true if the content ends with a newline character. Empty content
bpatel@766	97	* is considered as ending with new line.
bpatel@766	98	*
bpatel@766	99	* @param contentBuilder content to test for newline character at the end
bpatel@766	100	* @return true if the content ends with newline.
bpatel@766	101	*/
bpatel@819	102	protected boolean endsWithNewLine(StringBuilder contentBuilder) {
bpatel@819	103	int contentLength = contentBuilder.length();
bpatel@819	104	if (contentLength == 0) {
bpatel@819	105	return true;
bpatel@819	106	}
bpatel@819	107	int nlLength = DocletConstants.NL.length();
bpatel@819	108	if (contentLength < nlLength) {
bpatel@819	109	return false;
bpatel@819	110	}
bpatel@819	111	int contentIndex = contentLength - 1;
bpatel@819	112	int nlIndex = nlLength - 1;
bpatel@819	113	while (nlIndex >= 0) {
bpatel@819	114	if (contentBuilder.charAt(contentIndex) != DocletConstants.NL.charAt(nlIndex)) {
bpatel@819	115	return false;
bpatel@819	116	}
bpatel@819	117	contentIndex--;
bpatel@819	118	nlIndex--;
bpatel@819	119	}
bpatel@819	120	return true;
bpatel@766	121	}
bpatel@766	122	}