Copyright (c) 2007, 2013 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
    IBM Corporation - initial API and implementation
/*******************************************************************************
 * Copyright (c) 2007, 2013 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jdt.internal.corext.util;

import org.eclipse.core.runtime.IStatus;

import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.JavaConventions;
import org.eclipse.jdt.core.JavaCore;

Provides methods for checking Java-specific conventions such as name syntax.
 This is a wrapper for JavaConventions with more convenient validate*(..) methods. If multiple validations are planned on the same element, please use JavaConventions directly (with the arguments from getSourceComplianceLevels(IJavaElement)). 
See Also:
JDTUIHelperClasses/**
 * Provides methods for checking Java-specific conventions such as name syntax.
 * <p>
 * This is a wrapper for {@link JavaConventions} with more convenient
 * <code>validate*(..)</code> methods. If multiple validations are planned on
 * the same element, please use {@link JavaConventions} directly (with the
 * arguments from {@link #getSourceComplianceLevels(IJavaElement)}).
 * </p>
 * 
 * @see JDTUIHelperClasses
 */
public class JavaConventionsUtil {

	
Params:
context – an IJavaElement or null
Returns:
a String[] whose [0] is the JavaCore.COMPILER_SOURCE and whose [1] is the JavaCore.COMPILER_COMPLIANCE level at the given context./**
	 * @param context an {@link IJavaElement} or <code>null</code>
	 * @return a <code>String[]</code> whose <code>[0]</code> is the
	 *         {@link JavaCore#COMPILER_SOURCE} and whose <code>[1]</code> is
	 *         the {@link JavaCore#COMPILER_COMPLIANCE} level at the given
	 *         <code>context</code>.
	 */
	public static String[] getSourceComplianceLevels(IJavaElement context) {
		if (context != null) {
			IJavaProject javaProject= context.getJavaProject();
			if (javaProject != null) {
				return new String[] {
						javaProject.getOption(JavaCore.COMPILER_SOURCE, true),
						javaProject.getOption(JavaCore.COMPILER_COMPLIANCE, true)
				};
			}
		}
		return new String[] {
				JavaCore.getOption(JavaCore.COMPILER_SOURCE),
				JavaCore.getOption(JavaCore.COMPILER_COMPLIANCE)
		};
	}

	
Params:
name – the name to validate
context – an IJavaElement or null
See Also:
JavaConventions.validateCompilationUnitName(String, String, String)
Returns:
validation status in context's project or in the workspace/**
	 * @param name the name to validate
	 * @param context an {@link IJavaElement} or <code>null</code>
	 * @return validation status in <code>context</code>'s project or in the workspace
	 *
	 * @see JavaConventions#validateCompilationUnitName(String, String, String)
	 */
	public static IStatus validateCompilationUnitName(String name, IJavaElement context) {
		String[] sourceComplianceLevels= getSourceComplianceLevels(context);
		return JavaConventions.validateCompilationUnitName(name, sourceComplianceLevels[0], sourceComplianceLevels[1]);
	}

	
Params:
name – the name to validate
context – an IJavaElement or null
See Also:
JavaConventions.validateClassFileName(String, String, String)
Returns:
validation status in context's project or in the workspace/**
	 * @param name the name to validate
	 * @param context an {@link IJavaElement} or <code>null</code>
	 * @return validation status in <code>context</code>'s project or in the workspace
	 *
	 * @see JavaConventions#validateClassFileName(String, String, String)
	 */
	public static IStatus validateClassFileName(String name, IJavaElement context) {
		String[] sourceComplianceLevels= getSourceComplianceLevels(context);
		return JavaConventions.validateClassFileName(name, sourceComplianceLevels[0], sourceComplianceLevels[1]);
	}

	
Params:
name – the name to validate
context – an IJavaElement or null
See Also:
JavaConventions.validateFieldName(String, String, String)
Returns:
validation status in context's project or in the workspace/**
	 * @param name the name to validate
	 * @param context an {@link IJavaElement} or <code>null</code>
	 * @return validation status in <code>context</code>'s project or in the workspace
	 *
	 * @see JavaConventions#validateFieldName(String, String, String)
	 */
	public static IStatus validateFieldName(String name, IJavaElement context) {
		String[] sourceComplianceLevels= getSourceComplianceLevels(context);
		return JavaConventions.validateFieldName(name, sourceComplianceLevels[0], sourceComplianceLevels[1]);
	}

	
Params:
name – the name to validate
context – an IJavaElement or null
See Also:
JavaConventions.validateIdentifier(String, String, String)
Returns:
validation status in context's project or in the workspace/**
	 * @param name the name to validate
	 * @param context an {@link IJavaElement} or <code>null</code>
	 * @return validation status in <code>context</code>'s project or in the workspace
	 *
	 * @see JavaConventions#validateIdentifier(String, String, String)
	 */
	public static IStatus validateIdentifier(String name, IJavaElement context) {
		String[] sourceComplianceLevels= getSourceComplianceLevels(context);
		return JavaConventions.validateIdentifier(name, sourceComplianceLevels[0], sourceComplianceLevels[1]);
	}

	
Params:
name – the name to validate
context – an IJavaElement or null
See Also:
JavaConventions.validateImportDeclaration(String, String, String)
Returns:
validation status in context's project or in the workspace/**
	 * @param name the name to validate
	 * @param context an {@link IJavaElement} or <code>null</code>
	 * @return validation status in <code>context</code>'s project or in the workspace
	 *
	 * @see JavaConventions#validateImportDeclaration(String, String, String)
	 */
	public static IStatus validateImportDeclaration(String name, IJavaElement context) {
		String[] sourceComplianceLevels= getSourceComplianceLevels(context);
		return JavaConventions.validateImportDeclaration(name, sourceComplianceLevels[0], sourceComplianceLevels[1]);
	}

	
Params:
name – the name to validate
context – an IJavaElement or null
See Also:
JavaConventions.validateJavaTypeName(String, String, String)
Returns:
validation status in context's project or in the workspace/**
	 * @param name the name to validate
	 * @param context an {@link IJavaElement} or <code>null</code>
	 * @return validation status in <code>context</code>'s project or in the workspace
	 *
	 * @see JavaConventions#validateJavaTypeName(String, String, String)
	 */
	public static IStatus validateJavaTypeName(String name, IJavaElement context) {
		String[] sourceComplianceLevels= getSourceComplianceLevels(context);
		return JavaConventions.validateJavaTypeName(name, sourceComplianceLevels[0], sourceComplianceLevels[1]);
	}

	
Params:
name – the name to validate
context – an IJavaElement or null
See Also:
JavaConventions.validateMethodName(String, String, String)
Returns:
validation status in context's project or in the workspace/**
	 * @param name the name to validate
	 * @param context an {@link IJavaElement} or <code>null</code>
	 * @return validation status in <code>context</code>'s project or in the workspace
	 *
	 * @see JavaConventions#validateMethodName(String, String, String)
	 */
	public static IStatus validateMethodName(String name, IJavaElement context) {
		String[] sourceComplianceLevels= getSourceComplianceLevels(context);
		return JavaConventions.validateMethodName(name, sourceComplianceLevels[0], sourceComplianceLevels[1]);
	}

	
Params:
name – the name to validate
context – an IJavaElement or null
See Also:
JavaConventions.validatePackageName(String, String, String)
Returns:
validation status in context's project or in the workspace/**
	 * @param name the name to validate
	 * @param context an {@link IJavaElement} or <code>null</code>
	 * @return validation status in <code>context</code>'s project or in the workspace
	 *
	 * @see JavaConventions#validatePackageName(String, String, String)
	 */
	public static IStatus validatePackageName(String name, IJavaElement context) {
		String[] sourceComplianceLevels= getSourceComplianceLevels(context);
		return JavaConventions.validatePackageName(name, sourceComplianceLevels[0], sourceComplianceLevels[1]);
	}

	
Params:
name – the name to validate
context – an IJavaElement or null
See Also:
JavaConventions.validateTypeVariableName(String, String, String)
Returns:
validation status in context's project or in the workspace/**
	 * @param name the name to validate
	 * @param context an {@link IJavaElement} or <code>null</code>
	 * @return validation status in <code>context</code>'s project or in the workspace
	 *
	 * @see JavaConventions#validateTypeVariableName(String, String, String)
	 */
	public static IStatus validateTypeVariableName(String name, IJavaElement context) {
		String[] sourceComplianceLevels= getSourceComplianceLevels(context);
		return JavaConventions.validateTypeVariableName(name, sourceComplianceLevels[0], sourceComplianceLevels[1]);
	}
}