jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/Content.java@25e14ad23cef

     1 /*

     2  * Copyright (c) 2010, 2012, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    26 package com.sun.tools.doclets.internal.toolkit;

    28 import com.sun.tools.doclets.internal.toolkit.util.*;

    30 /**

    31  * A class to create content for javadoc output pages.

    32  *

    33  *  <p><b>This is NOT part of any supported API.

    34  *  If you write code that depends on this, you do so at your own risk.

    35  *  This code and its internal interfaces are subject to change or

    36  *  deletion without notice.</b>

    37  *

    38  * @author Bhavesh Patel

    39  */

    40 public abstract class Content {

    42     /**

    43      * Returns a string representation of the content.

    44      *

    45      * @return string representation of the content

    46      */

    47     public String toString() {

    48         StringBuilder contentBuilder = new StringBuilder();

    49         write(contentBuilder);

    50         return contentBuilder.toString();

    51     }

    53     /**

    54      * Adds content to the existing content.

    55      *

    56      * @param content content that needs to be added

    57      */

    58     public abstract void addContent(Content content);

    60     /**

    61      * Adds a string content to the existing content.

    62      *

    63      * @param stringContent the string content to be added

    64      */

    65     public abstract void addContent(String stringContent);

    67     /**

    68      * Writes content to a StringBuilder.

    69      *

    70      */

    71     public abstract void write(StringBuilder contentBuilder);

    73     /**

    74      * Returns true if the content is empty.

    75      *

    76      * @return true if no content to be displayed else return false

    77      */

    78     public abstract boolean isEmpty();

    80     /**

    81      * Returns true if the content is valid.

    82      *

    83      * @return true if the content is valid else return false

    84      */

    85     public boolean isValid() {

    86         return !isEmpty();

    87     }

    89     /**

    90      * Checks for null values.

    91      *

    92      * @param t reference type to check for null values

    93      * @return the reference type if not null or else throws a null pointer exception

    94      */

    95     protected static <T> T nullCheck(T t) {

    96         t.getClass();

    97         return t;

    98     }

   100     /**

   101      * Returns true if the content ends with a newline character. Empty content

   102      * is considered as ending with new line.

   103      *

   104      * @param contentBuilder content to test for newline character at the end

   105      * @return true if the content ends with newline.

   106      */

   107     protected boolean endsWithNewLine(StringBuilder contentBuilder) {

   108         int contentLength = contentBuilder.length();

   109         if (contentLength == 0) {

   110             return true;

   111         }

   112         int nlLength = DocletConstants.NL.length();

   113         if (contentLength < nlLength) {

   114             return false;

   115         }

   116         int contentIndex = contentLength - 1;

   117         int nlIndex = nlLength - 1;

   118         while (nlIndex >= 0) {

   119             if (contentBuilder.charAt(contentIndex) != DocletConstants.NL.charAt(nlIndex)) {

   120                 return false;

   121             }

   122             contentIndex--;

   123             nlIndex--;

   124         }

   125         return true;

   126     }

   127 }

Mercurial > jdk8-mips64-public > langtools / file revision