Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/Content.java@93012e2a5d1d (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/Content.java
Sat, 07 Nov 2020 10:30:02 +0800
- author
- aoqi
- date
- Sat, 07 Nov 2020 10:30:02 +0800
- changeset 3938
- 93012e2a5d1d
- parent 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
Added tag mips-jdk8u275-b01 for changeset eb6ee6a5f2fe
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.tools.doclets.internal.toolkit; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.io.IOException; |
| aoqi@0 | 29 | import java.io.StringWriter; |
| aoqi@0 | 30 | import java.io.Writer; |
| aoqi@0 | 31 | |
| aoqi@0 | 32 | import com.sun.tools.doclets.internal.toolkit.util.*; |
| aoqi@0 | 33 | |
| aoqi@0 | 34 | /** |
| aoqi@0 | 35 | * A class to create content for javadoc output pages. |
| aoqi@0 | 36 | * |
| aoqi@0 | 37 | * <p><b>This is NOT part of any supported API. |
| aoqi@0 | 38 | * If you write code that depends on this, you do so at your own risk. |
| aoqi@0 | 39 | * This code and its internal interfaces are subject to change or |
| aoqi@0 | 40 | * deletion without notice.</b> |
| aoqi@0 | 41 | * |
| aoqi@0 | 42 | * @author Bhavesh Patel |
| aoqi@0 | 43 | */ |
| aoqi@0 | 44 | public abstract class Content { |
| aoqi@0 | 45 | |
| aoqi@0 | 46 | /** |
| aoqi@0 | 47 | * Returns a string representation of the content. |
| aoqi@0 | 48 | * |
| aoqi@0 | 49 | * @return string representation of the content |
| aoqi@0 | 50 | */ |
| aoqi@0 | 51 | @Override |
| aoqi@0 | 52 | public String toString() { |
| aoqi@0 | 53 | StringWriter out = new StringWriter(); |
| aoqi@0 | 54 | try { |
| aoqi@0 | 55 | write(out, true); |
| aoqi@0 | 56 | } catch (IOException e) { |
| aoqi@0 | 57 | // cannot happen from StringWriter |
| aoqi@0 | 58 | throw new DocletAbortException(e); |
| aoqi@0 | 59 | } |
| aoqi@0 | 60 | return out.toString(); |
| aoqi@0 | 61 | } |
| aoqi@0 | 62 | |
| aoqi@0 | 63 | /** |
| aoqi@0 | 64 | * Adds content to the existing content. |
| aoqi@0 | 65 | * |
| aoqi@0 | 66 | * @param content content that needs to be added |
| aoqi@0 | 67 | */ |
| aoqi@0 | 68 | public abstract void addContent(Content content); |
| aoqi@0 | 69 | |
| aoqi@0 | 70 | /** |
| aoqi@0 | 71 | * Adds a string content to the existing content. |
| aoqi@0 | 72 | * |
| aoqi@0 | 73 | * @param stringContent the string content to be added |
| aoqi@0 | 74 | */ |
| aoqi@0 | 75 | public abstract void addContent(String stringContent); |
| aoqi@0 | 76 | |
| aoqi@0 | 77 | /** |
| aoqi@0 | 78 | * Writes content to a writer. |
| aoqi@0 | 79 | * |
| aoqi@0 | 80 | */ |
| aoqi@0 | 81 | public abstract boolean write(Writer writer, boolean atNewline) throws IOException ; |
| aoqi@0 | 82 | |
| aoqi@0 | 83 | /** |
| aoqi@0 | 84 | * Returns true if the content is empty. |
| aoqi@0 | 85 | * |
| aoqi@0 | 86 | * @return true if no content to be displayed else return false |
| aoqi@0 | 87 | */ |
| aoqi@0 | 88 | public abstract boolean isEmpty(); |
| aoqi@0 | 89 | |
| aoqi@0 | 90 | /** |
| aoqi@0 | 91 | * Returns true if the content is valid. |
| aoqi@0 | 92 | * |
| aoqi@0 | 93 | * @return true if the content is valid else return false |
| aoqi@0 | 94 | */ |
| aoqi@0 | 95 | public boolean isValid() { |
| aoqi@0 | 96 | return !isEmpty(); |
| aoqi@0 | 97 | } |
| aoqi@0 | 98 | |
| aoqi@0 | 99 | /** |
| aoqi@0 | 100 | * Return the number of characters of plain text content in this object |
| aoqi@0 | 101 | * (optional operation.) |
| aoqi@0 | 102 | * @return the number of characters of plain text content in this |
| aoqi@0 | 103 | */ |
| aoqi@0 | 104 | public int charCount() { |
| aoqi@0 | 105 | return 0; |
| aoqi@0 | 106 | } |
| aoqi@0 | 107 | |
| aoqi@0 | 108 | /** |
| aoqi@0 | 109 | * Checks for null values. |
| aoqi@0 | 110 | * |
| aoqi@0 | 111 | * @param t reference type to check for null values |
| aoqi@0 | 112 | * @return the reference type if not null or else throws a null pointer exception |
| aoqi@0 | 113 | */ |
| aoqi@0 | 114 | protected static <T> T nullCheck(T t) { |
| aoqi@0 | 115 | t.getClass(); |
| aoqi@0 | 116 | return t; |
| aoqi@0 | 117 | } |
| aoqi@0 | 118 | } |
