JavadocTagConstants.java

/*******************************************************************************
 * Copyright (c) 2000, 2009 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.jdt.internal.compiler.parser;

import org.eclipse.jdt.core.compiler.CharOperation;

/**
 * Javadoc tag constants.
 * 
 * @since 3.2
 */
public interface JavadocTagConstants {

	// recognized tags
	public static final char[] TAG_DEPRECATED= "deprecated".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_PARAM= "param".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_RETURN= "return".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_THROWS= "throws".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_EXCEPTION= "exception".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_SEE= "see".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_LINK= "link".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_LINKPLAIN= "linkplain".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_INHERITDOC= "inheritDoc".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_VALUE= "value".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_AUTHOR= "author".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_CODE= "code".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_DOC_ROOT= "docRoot".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_LITERAL= "literal".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_SERIAL= "serial".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_SERIAL_DATA= "serialData".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_SERIAL_FIELD= "serialField".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_SINCE= "since".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_VERSION= "version".toCharArray(); //$NON-NLS-1$

	public static final char[] TAG_CATEGORY= "category".toCharArray(); //$NON-NLS-1$

	// tags lengthes
	public static final int TAG_DEPRECATED_LENGTH= TAG_DEPRECATED.length;

	public static final int TAG_PARAM_LENGTH= TAG_PARAM.length;

	public static final int TAG_RETURN_LENGTH= TAG_RETURN.length;

	public static final int TAG_THROWS_LENGTH= TAG_THROWS.length;

	public static final int TAG_EXCEPTION_LENGTH= TAG_EXCEPTION.length;

	public static final int TAG_SEE_LENGTH= TAG_SEE.length;

	public static final int TAG_LINK_LENGTH= TAG_LINK.length;

	public static final int TAG_LINKPLAIN_LENGTH= TAG_LINKPLAIN.length;

	public static final int TAG_INHERITDOC_LENGTH= TAG_INHERITDOC.length;

	public static final int TAG_VALUE_LENGTH= TAG_VALUE.length;

	public static final int TAG_CATEGORY_LENGTH= TAG_CATEGORY.length;

	public static final int TAG_AUTHOR_LENGTH= TAG_AUTHOR.length;

	public static final int TAG_SERIAL_LENGTH= TAG_SERIAL.length;

	public static final int TAG_SERIAL_DATA_LENGTH= TAG_SERIAL_DATA.length;

	public static final int TAG_SERIAL_FIELD_LENGTH= TAG_SERIAL_FIELD.length;

	public static final int TAG_SINCE_LENGTH= TAG_SINCE.length;

	public static final int TAG_VERSION_LENGTH= TAG_VERSION.length;

	public static final int TAG_CODE_LENGTH= TAG_CODE.length;

	public static final int TAG_LITERAL_LENGTH= TAG_LITERAL.length;

	public static final int TAG_DOC_ROOT_LENGTH= TAG_DOC_ROOT.length;

	// tags value
	public static final int NO_TAG_VALUE= 0;

	public static final int TAG_DEPRECATED_VALUE= 1;

	public static final int TAG_PARAM_VALUE= 2;

	public static final int TAG_RETURN_VALUE= 3;

	public static final int TAG_THROWS_VALUE= 4;

	public static final int TAG_EXCEPTION_VALUE= 5;

	public static final int TAG_SEE_VALUE= 6;

	public static final int TAG_LINK_VALUE= 7;

	public static final int TAG_LINKPLAIN_VALUE= 8;

	public static final int TAG_INHERITDOC_VALUE= 9;

	public static final int TAG_VALUE_VALUE= 10;

	public static final int TAG_CATEGORY_VALUE= 11;

	public static final int TAG_AUTHOR_VALUE= 12;

	public static final int TAG_SERIAL_VALUE= 13;

	public static final int TAG_SERIAL_DATA_VALUE= 14;

	public static final int TAG_SERIAL_FIELD_VALUE= 15;

	public static final int TAG_SINCE_VALUE= 16;

	public static final int TAG_VERSION_VALUE= 17;

	public static final int TAG_CODE_VALUE= 18;

	public static final int TAG_LITERAL_VALUE= 19;

	public static final int TAG_DOC_ROOT_VALUE= 20;

	public static final int TAG_OTHERS_VALUE= 100;

	// Tag names array
	public static final char[][] TAG_NAMES= {
			CharOperation.NO_CHAR,
			TAG_DEPRECATED, /* 1 */
			TAG_PARAM, /* 2 */
			TAG_RETURN, /* 3 */
			TAG_THROWS, /* 4 */
			TAG_EXCEPTION, /* 5 */
			TAG_SEE, /* 6 */
			TAG_LINK, /* 7 */
			TAG_LINKPLAIN, /* 8 */
			TAG_INHERITDOC, /* 9 */
			TAG_VALUE, /* 10 */
			TAG_CATEGORY, /* 11 */
			TAG_AUTHOR, /* 12 */
			TAG_SERIAL, /* 13 */
			TAG_SERIAL_DATA, /* 14 */
			TAG_SERIAL_FIELD, /* 15 */
			TAG_SINCE, /* 16 */
			TAG_VERSION, /* 17 */
			TAG_CODE, /* 18 */
			TAG_LITERAL, /* 19 */
			TAG_DOC_ROOT, /* 20 */
	};

	// tags expected positions
	public final static int ORDERED_TAGS_NUMBER= 3;

	public final static int PARAM_TAG_EXPECTED_ORDER= 0;

	public final static int THROWS_TAG_EXPECTED_ORDER= 1;

	public final static int SEE_TAG_EXPECTED_ORDER= 2;

	/*
	 * Tag kinds indexes
	 */
	public final static int BLOCK_IDX= 0;

	public final static int INLINE_IDX= 1;

	// href tag
	public final static char[] HREF_TAG= { 'h', 'r', 'e', 'f' };

	/*
	 * Tags versions
	 */
	public static final char[][][] BLOCK_TAGS= {
			// since 1.0
			{ TAG_AUTHOR, TAG_DEPRECATED, TAG_EXCEPTION, TAG_PARAM, TAG_RETURN, TAG_SEE, TAG_VERSION, TAG_CATEGORY /* 1.6 tag but put here as we support it for all compliances */},
			// since 1.1
			{ TAG_SINCE },
			// since 1.2
			{ TAG_SERIAL, TAG_SERIAL_DATA, TAG_SERIAL_FIELD, TAG_THROWS },
			// since 1.3
			{},
			// since 1.4
			{},
			// since 1.5
			{},
			// since 1.6
			{},
			// since 1.7
			{},
	};

	public static final char[][][] INLINE_TAGS= {
			// since 1.0
			{},
			// since 1.1
			{},
			// since 1.2
			{ TAG_LINK },
			// since 1.3
			{ TAG_DOC_ROOT },
			// since 1.4
			{ TAG_INHERITDOC, TAG_LINKPLAIN, TAG_VALUE },
			// since 1.5
			{ TAG_CODE, TAG_LITERAL },
			// since 1.6
			{},
			// since 1.7
			{},
	};

	public final static int INLINE_TAGS_LENGTH= INLINE_TAGS.length;

	public final static int BLOCK_TAGS_LENGTH= BLOCK_TAGS.length;

	public final static int ALL_TAGS_LENGTH= BLOCK_TAGS_LENGTH + INLINE_TAGS_LENGTH;

	public final static short TAG_TYPE_NONE= 0;

	public final static short TAG_TYPE_INLINE= 1;

	public final static short TAG_TYPE_BLOCK= 2;

	public static final short[] JAVADOC_TAG_TYPE= {
			TAG_TYPE_NONE, // NO_TAG_VALUE = 0;
			TAG_TYPE_BLOCK, // TAG_DEPRECATED_VALUE = 1;
			TAG_TYPE_BLOCK, // TAG_PARAM_VALUE = 2;
			TAG_TYPE_BLOCK, // TAG_RETURN_VALUE = 3;
			TAG_TYPE_BLOCK, // TAG_THROWS_VALUE = 4;
			TAG_TYPE_BLOCK, // TAG_EXCEPTION_VALUE = 5;
			TAG_TYPE_BLOCK, // TAG_SEE_VALUE = 6;
			TAG_TYPE_INLINE, // TAG_LINK_VALUE = 7;
			TAG_TYPE_INLINE, // TAG_LINKPLAIN_VALUE = 8;
			TAG_TYPE_INLINE, // TAG_INHERITDOC_VALUE = 9;
			TAG_TYPE_INLINE, // TAG_VALUE_VALUE = 10;
			TAG_TYPE_BLOCK, // TAG_CATEGORY_VALUE = 11;
			TAG_TYPE_BLOCK, // TAG_AUTHOR_VALUE = 12;
			TAG_TYPE_BLOCK, // TAG_SERIAL_VALUE = 13;
			TAG_TYPE_BLOCK, // TAG_SERIAL_DATA_VALUE = 14;
			TAG_TYPE_BLOCK, // TAG_SERIAL_FIELD_VALUE = 15;
			TAG_TYPE_BLOCK, // TAG_SINCE_VALUE = 16;
			TAG_TYPE_BLOCK, // TAG_VERSION_VALUE = 17;
			TAG_TYPE_INLINE, // TAG_CODE_VALUE = 18;
			TAG_TYPE_INLINE, // TAG_LITERAL_VALUE = 19;
			TAG_TYPE_INLINE // TAG_DOC_ROOT_VALUE = 20;
	};

	/*
	 * Tags usage
	 */
	public static final char[][] PACKAGE_TAGS= {
			TAG_SEE,
			TAG_SINCE,
			TAG_SERIAL,
			TAG_AUTHOR,
			TAG_VERSION,
			TAG_CATEGORY,
			TAG_LINK,
			TAG_LINKPLAIN,
			TAG_DOC_ROOT,
			TAG_VALUE,
	};

	public static final char[][] COMPILATION_UNIT_TAGS= {};

	public static final char[][] CLASS_TAGS= {
			TAG_SEE,
			TAG_SINCE,
			TAG_DEPRECATED,
			TAG_SERIAL,
			TAG_AUTHOR,
			TAG_VERSION,
			TAG_PARAM,
			TAG_CATEGORY,
			TAG_LINK,
			TAG_LINKPLAIN,
			TAG_DOC_ROOT,
			TAG_VALUE,
			TAG_CODE,
			TAG_LITERAL
	};

	public static final char[][] FIELD_TAGS= {
			TAG_SEE,
			TAG_SINCE,
			TAG_DEPRECATED,
			TAG_SERIAL,
			TAG_SERIAL_FIELD,
			TAG_CATEGORY,
			TAG_LINK,
			TAG_LINKPLAIN,
			TAG_DOC_ROOT,
			TAG_VALUE,
			TAG_CODE,
			TAG_LITERAL
	};

	public static final char[][] METHOD_TAGS= {
			TAG_SEE,
			TAG_SINCE,
			TAG_DEPRECATED,
			TAG_PARAM,
			TAG_RETURN,
			TAG_THROWS,
			TAG_EXCEPTION,
			TAG_SERIAL_DATA,
			TAG_CATEGORY,
			TAG_LINK,
			TAG_LINKPLAIN,
			TAG_INHERITDOC,
			TAG_DOC_ROOT,
			TAG_VALUE,
			TAG_CODE,
			TAG_LITERAL
	};
}