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

src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlTag.java@90af8d87741f (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlTag.java

Wed, 01 Dec 2010 11:02:38 -0800

author

bpatel

date

Wed, 01 Dec 2010 11:02:38 -0800

changeset 766

90af8d87741f

child 1359

25e14ad23cef

permissions

-rw-r--r--

6851834: Javadoc doclet needs a structured approach to generate the output HTML.
Reviewed-by: jjg

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.formats.html.markup;
bpatel@766	27
bpatel@766	28	/**
bpatel@766	29	* Enum representing HTML tags.
bpatel@766	30	*
bpatel@766	31	* @author Bhavesh Patel
bpatel@766	32	*/
bpatel@766	33	public enum HtmlTag {
bpatel@766	34	A(BlockType.INLINE, EndTag.END),
bpatel@766	35	BLOCKQUOTE,
bpatel@766	36	BODY(BlockType.OTHER, EndTag.END),
bpatel@766	37	BR(BlockType.INLINE, EndTag.NOEND),
bpatel@766	38	CAPTION,
bpatel@766	39	CENTER,
bpatel@766	40	CODE(BlockType.INLINE, EndTag.END),
bpatel@766	41	DD,
bpatel@766	42	DIV,
bpatel@766	43	DL,
bpatel@766	44	DT,
bpatel@766	45	EM(BlockType.INLINE, EndTag.END),
bpatel@766	46	FONT(BlockType.INLINE, EndTag.END),
bpatel@766	47	FRAME(BlockType.OTHER, EndTag.NOEND),
bpatel@766	48	FRAMESET(BlockType.OTHER, EndTag.END),
bpatel@766	49	H1,
bpatel@766	50	H2,
bpatel@766	51	H3,
bpatel@766	52	H4,
bpatel@766	53	H5,
bpatel@766	54	H6,
bpatel@766	55	HEAD(BlockType.OTHER, EndTag.END),
bpatel@766	56	HR(BlockType.BLOCK, EndTag.NOEND),
bpatel@766	57	HTML(BlockType.OTHER, EndTag.END),
bpatel@766	58	I(BlockType.INLINE, EndTag.END),
bpatel@766	59	IMG(BlockType.INLINE, EndTag.NOEND),
bpatel@766	60	LI,
bpatel@766	61	LINK(BlockType.OTHER, EndTag.NOEND),
bpatel@766	62	MENU,
bpatel@766	63	META(BlockType.OTHER, EndTag.NOEND),
bpatel@766	64	NOFRAMES(BlockType.OTHER, EndTag.END),
bpatel@766	65	NOSCRIPT(BlockType.OTHER, EndTag.END),
bpatel@766	66	OL,
bpatel@766	67	P,
bpatel@766	68	PRE,
bpatel@766	69	SCRIPT(BlockType.OTHER, EndTag.END),
bpatel@766	70	SMALL(BlockType.INLINE, EndTag.END),
bpatel@766	71	SPAN(BlockType.INLINE, EndTag.END),
bpatel@766	72	STRONG(BlockType.INLINE, EndTag.END),
bpatel@766	73	TABLE,
bpatel@766	74	TBODY,
bpatel@766	75	TD,
bpatel@766	76	TH,
bpatel@766	77	TITLE(BlockType.OTHER, EndTag.END),
bpatel@766	78	TR,
bpatel@766	79	TT(BlockType.INLINE, EndTag.END),
bpatel@766	80	UL;
bpatel@766	81
bpatel@766	82	protected final BlockType blockType;
bpatel@766	83	protected final EndTag endTag;
bpatel@766	84	private final String value;
bpatel@766	85
bpatel@766	86	/**
bpatel@766	87	* Enum representing the type of HTML element.
bpatel@766	88	*/
bpatel@766	89	protected static enum BlockType {
bpatel@766	90	BLOCK,
bpatel@766	91	INLINE,
bpatel@766	92	OTHER;
bpatel@766	93	}
bpatel@766	94
bpatel@766	95	/**
bpatel@766	96	* Enum representing HTML end tag requirement.
bpatel@766	97	*/
bpatel@766	98	protected static enum EndTag {
bpatel@766	99	END,
bpatel@766	100	NOEND;
bpatel@766	101	}
bpatel@766	102
bpatel@766	103	HtmlTag() {
bpatel@766	104	this(BlockType.BLOCK, EndTag.END);
bpatel@766	105	}
bpatel@766	106
bpatel@766	107	HtmlTag(BlockType blockType, EndTag endTag ) {
bpatel@766	108	this.blockType = blockType;
bpatel@766	109	this.endTag = endTag;
bpatel@766	110	this.value = name().toLowerCase();
bpatel@766	111	}
bpatel@766	112
bpatel@766	113	/**
bpatel@766	114	* Returns true if the end tag is required. This is specific to the standard
bpatel@766	115	* doclet and does not exactly resemble the W3C specifications.
bpatel@766	116	*
bpatel@766	117	* @return true if end tag needs to be displayed else return false
bpatel@766	118	*/
bpatel@766	119	public boolean endTagRequired() {
bpatel@766	120	return (endTag == EndTag.END);
bpatel@766	121	}
bpatel@766	122
bpatel@766	123	public String toString() {
bpatel@766	124	return value;
bpatel@766	125	}
bpatel@766	126	}