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

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocLink.java@fcf89720ae71 (annotated)

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

Mon, 10 Dec 2012 16:21:26 +0000

author

vromero

date

Mon, 10 Dec 2012 16:21:26 +0000

changeset 1442

fcf89720ae71

parent 0

959103a6100f

permissions

-rw-r--r--

8003967: detect and remove all mutable implicit static enum fields in langtools
Reviewed-by: jjg

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2012, 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.util;
aoqi@0	27
aoqi@0	28	/**
aoqi@0	29	* Abstraction for simple relative URIs, consisting of a path,
aoqi@0	30	* an optional query, and an optional fragment. DocLink objects can
aoqi@0	31	* be created by the constructors below or from a DocPath using the
aoqi@0	32	* convenience methods, {@link DocPath#fragment fragment} and
aoqi@0	33	* {@link DocPath#query query}.
aoqi@0	34	*
aoqi@0	35	* <p><b>This is NOT part of any supported API.
aoqi@0	36	* If you write code that depends on this, you do so at your own risk.
aoqi@0	37	* This code and its internal interfaces are subject to change or
aoqi@0	38	* deletion without notice.</b>
aoqi@0	39	*
aoqi@0	40	*/
aoqi@0	41	public class DocLink {
aoqi@0	42	final String path;
aoqi@0	43	final String query;
aoqi@0	44	final String fragment;
aoqi@0	45
aoqi@0	46	/** Create a DocLink representing the URI {@code #fragment}. */
aoqi@0	47	public static DocLink fragment(String fragment) {
aoqi@0	48	return new DocLink((String) null, (String) null, fragment);
aoqi@0	49	}
aoqi@0	50
aoqi@0	51	/** Create a DocLink representing the URI {@code path}. */
aoqi@0	52	public DocLink(DocPath path) {
aoqi@0	53	this(path.getPath(), null, null);
aoqi@0	54	}
aoqi@0	55
aoqi@0	56	/**
aoqi@0	57	* Create a DocLink representing the URI {@code path?query#fragment}.
aoqi@0	58	* query and fragment may be null.
aoqi@0	59	*/
aoqi@0	60	public DocLink(DocPath path, String query, String fragment) {
aoqi@0	61	this(path.getPath(), query, fragment);
aoqi@0	62	}
aoqi@0	63
aoqi@0	64	/**
aoqi@0	65	* Create a DocLink representing the URI {@code path?query#fragment}.
aoqi@0	66	* Any of the component parts may be null.
aoqi@0	67	*/
aoqi@0	68	public DocLink(String path, String query, String fragment) {
aoqi@0	69	this.path = path;
aoqi@0	70	this.query = query;
aoqi@0	71	this.fragment = fragment;
aoqi@0	72	}
aoqi@0	73
aoqi@0	74	/**
aoqi@0	75	* Return the link in the form "path?query#fragment", omitting any empty
aoqi@0	76	* components.
aoqi@0	77	*/
aoqi@0	78	@Override
aoqi@0	79	public String toString() {
aoqi@0	80	// common fast path
aoqi@0	81	if (path != null && isEmpty(query) && isEmpty(fragment))
aoqi@0	82	return path;
aoqi@0	83
aoqi@0	84	StringBuilder sb = new StringBuilder();
aoqi@0	85	if (path != null)
aoqi@0	86	sb.append(path);
aoqi@0	87	if (!isEmpty(query))
aoqi@0	88	sb.append("?").append(query);
aoqi@0	89	if (!isEmpty(fragment))
aoqi@0	90	sb.append("#").append(fragment);
aoqi@0	91	return sb.toString();
aoqi@0	92	}
aoqi@0	93
aoqi@0	94	private static boolean isEmpty(String s) {
aoqi@0	95	return (s == null) || s.isEmpty();
aoqi@0	96	}
aoqi@0	97	}