src/jdk.xml.bind/share/classes/com/sun/codemodel/internal/JCommentPart.java
changeset 47216 71c04702a3d5
parent 25871 b80b84e87032
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/jdk.xml.bind/share/classes/com/sun/codemodel/internal/JCommentPart.java	Tue Sep 12 19:03:39 2017 +0200
@@ -0,0 +1,137 @@
+/*
+ * Copyright (c) 1997, 2012, 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
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * 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.codemodel.internal;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Iterator;
+
+/**
+ * A part is a part of a javadoc comment, and it is a list of values.
+ *
+ * <p>
+ * A part can contain a free-form text. This text is modeled as a collection of 'values'
+ * in this class. A value can be a {@link JType} (which will be prinited with a @link tag),
+ * anything that can be turned into a {@link String} via the {@link Object#toString()} method,
+ * or a {@link Collection}/array of those objects.
+ *
+ * <p>
+ * Values can be added through the various append methods one by one or in a bulk.
+ *
+ * @author Kohsuke Kawaguchi
+ */
+public class JCommentPart extends ArrayList<Object> {
+
+        private static final long serialVersionUID = 1L;
+
+        /**
+     * Appends a new value.
+     *
+     * If the value is {@link JType} it will be printed as a @link tag.
+     * Otherwise it will be converted to String via {@link Object#toString()}.
+     */
+    public JCommentPart append(Object o) {
+        add(o);
+        return this;
+    }
+
+    public boolean add(Object o) {
+        flattenAppend(o);
+        return true;
+    }
+
+    private void flattenAppend(Object value) {
+        if(value==null) return;
+        if(value instanceof Object[]) {
+            for( Object o : (Object[])value)
+                flattenAppend(o);
+        } else
+        if(value instanceof Collection<?>) {
+            for( Object o : (Collection<?>)value)
+                flattenAppend(o);
+        } else
+            super.add(value);
+    }
+
+    /**
+     * Writes this part into the formatter by using the specified indentation.
+     */
+    protected void format( JFormatter f, String indent ) {
+        if(!f.isPrinting()) {
+            // quickly pass the types to JFormatter, as that's all we care.
+            // we don't need to worry about the exact formatting of text.
+            for( Object o : this )
+                if(o instanceof JClass)
+                    f.g((JClass)o);
+            return;
+        }
+
+        if(!isEmpty())
+            f.p(indent);
+
+        Iterator<Object> itr = iterator();
+        while(itr.hasNext()) {
+            Object o = itr.next();
+
+            if(o instanceof String) {
+                int idx;
+                String s = (String)o;
+                while( (idx=s.indexOf('\n'))!=-1 ) {
+                    String line = s.substring(0,idx);
+                    if(line.length()>0)
+                        f.p(escape(line));
+                    s = s.substring(idx+1);
+                    f.nl().p(indent);
+                }
+                if(s.length()!=0)
+                    f.p(escape(s));
+            } else
+            if(o instanceof JClass) {
+                // TODO: this doesn't print the parameterized type properly
+                ((JClass)o).printLink(f);
+            } else
+            if(o instanceof JType) {
+                f.g((JType)o);
+            } else
+                throw new IllegalStateException();
+        }
+
+        if(!isEmpty())
+            f.nl();
+    }
+
+    /**
+     * Escapes the appearance of the comment terminator.
+     */
+    private String escape(String s) {
+        while(true) {
+            int idx = s.indexOf("*/");
+            if(idx <0)   return s;
+
+            s = s.substring(0,idx+1)+"<!---->"+s.substring(idx+1);
+        }
+    }
+}