Copyright (c) 2006, 2018 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) 2006, 2018 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.core.manipulation;

import java.util.regex.Pattern;

import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.dom.rewrite.ImportRewrite;

Gives access to the import rewrite configured with the settings as specified in the user interface.
These settings are kept in JDT UI for compatibility reasons.

This class is not intended to be subclassed or instantiated by clients.

Since:
1.10
@noinstantiate
This class is not intended to be instantiated by clients.
@noextend
This class is not intended to be subclassed by clients./**
 * Gives access to the import rewrite configured with the settings as specified in the user interface.
 * These settings are kept in JDT UI for compatibility reasons.
 *
 * <p>
 * This class is not intended to be subclassed or instantiated by clients.
 * </p>
 * @since 1.10
 *
 * @noinstantiate This class is not intended to be instantiated by clients.
 * @noextend This class is not intended to be subclassed by clients.
 */
public class CodeStyleConfiguration {

	private static final Pattern SEMICOLON_PATTERN= Pattern.compile(";"); //$NON-NLS-1$

	
A named preference that holds a list of semicolon separated package names. The list specifies the import order used by
the "Organize Imports" operation.

Value is of type String: semicolon separated list of package
names

/**
	 * A named preference that holds a list of semicolon separated package names. The list specifies the import order used by
	 * the "Organize Imports" operation.
	 * <p>
	 * Value is of type <code>String</code>: semicolon separated list of package
	 * names
	 * </p>
	 */
	public static final String ORGIMPORTS_IMPORTORDER= "org.eclipse.jdt.ui.importorder"; //$NON-NLS-1$

	
A named preference that specifies the number of imports added before a star-import declaration is used.

Value is of type Integer: positive value specifying the number of non star-import is used

/**
	 * A named preference that specifies the number of imports added before a star-import declaration is used.
	 * <p>
	 * Value is of type <code>Integer</code>: positive value specifying the number of non star-import is used
	 * </p>
	 */
	public static final String ORGIMPORTS_ONDEMANDTHRESHOLD= "org.eclipse.jdt.ui.ondemandthreshold"; //$NON-NLS-1$

	
A named preference that specifies the number of static imports added before a star-import declaration is used.

Value is of type Integer: positive value specifying the number of non star-import is used

/**
	 * A named preference that specifies the number of static imports added before a star-import declaration is used.
	 * <p>
	 * Value is of type <code>Integer</code>: positive value specifying the number of non star-import is used
	 * </p>
	 */
	public static final String ORGIMPORTS_STATIC_ONDEMANDTHRESHOLD= "org.eclipse.jdt.ui.staticondemandthreshold"; //$NON-NLS-1$

	private CodeStyleConfiguration() {
		// do not instantiate and subclass
	}


	
Returns a ImportRewrite using ImportRewrite.create(ICompilationUnit, boolean) and configures the rewriter with the settings as specified in the JDT UI preferences. 

Params:
cu – the compilation unit to create the rewriter on
restoreExistingImports – specifies if the existing imports should be kept or removed.
Throws:
JavaModelException – thrown when the compilation unit could not be accessed.
See Also:
ImportRewrite.create(ICompilationUnit, boolean)
Returns:
the new rewriter configured with the settings as specified in the JDT UI preferences./**
	 * Returns a {@link ImportRewrite} using {@link ImportRewrite#create(ICompilationUnit, boolean)} and
	 * configures the rewriter with the settings as specified in the JDT UI preferences.
	 * <p>
	 *
	 * @param cu the compilation unit to create the rewriter on
	 * @param restoreExistingImports specifies if the existing imports should be kept or removed.
	 * @return the new rewriter configured with the settings as specified in the JDT UI preferences.
	 * @throws JavaModelException thrown when the compilation unit could not be accessed.
	 *
	 * @see ImportRewrite#create(ICompilationUnit, boolean)
	 */
	public static ImportRewrite createImportRewrite(ICompilationUnit cu, boolean restoreExistingImports) throws JavaModelException {
		return configureImportRewrite(ImportRewrite.create(cu, restoreExistingImports));
	}

	
Returns a ImportRewrite using ImportRewrite.create(CompilationUnit, boolean) and configures the rewriter with the settings as specified in the JDT UI preferences. 
Params:
astRoot – the AST root to create the rewriter on
restoreExistingImports – specifies if the existing imports should be kept or removed.
See Also:
ImportRewrite.create(CompilationUnit, boolean)
Returns:
the new rewriter configured with the settings as specified in the JDT UI preferences./**
	 * Returns a {@link ImportRewrite} using {@link ImportRewrite#create(CompilationUnit, boolean)} and
	 * configures the rewriter with the settings as specified in the JDT UI preferences.
	 *
	 * @param astRoot the AST root to create the rewriter on
	 * @param restoreExistingImports specifies if the existing imports should be kept or removed.
	 * @return the new rewriter configured with the settings as specified in the JDT UI preferences.
	 *
	 * @see ImportRewrite#create(CompilationUnit, boolean)
	 */
	public static ImportRewrite createImportRewrite(CompilationUnit astRoot, boolean restoreExistingImports) {
		return configureImportRewrite(ImportRewrite.create(astRoot, restoreExistingImports));
	}

	private static ImportRewrite configureImportRewrite(ImportRewrite rewrite) {
		IJavaProject project= rewrite.getCompilationUnit().getJavaProject();
		String order= JavaManipulation.getPreference(ORGIMPORTS_IMPORTORDER, project);
		if (order.endsWith(";")) { //$NON-NLS-1$
			order= order.substring(0, order.length() - 1);
		}
		String[] split= SEMICOLON_PATTERN.split(order, -1);
		rewrite.setImportOrder(split);

		String thres= JavaManipulation.getPreference(ORGIMPORTS_ONDEMANDTHRESHOLD, project);
		try {
			int num= Integer.parseInt(thres);
			if (num == 0)
				num= 1;
			rewrite.setOnDemandImportThreshold(num);
		} catch (NumberFormatException e) {
			// ignore
		}
		String thresStatic= JavaManipulation.getPreference(ORGIMPORTS_STATIC_ONDEMANDTHRESHOLD, project);
		try {
			int num= Integer.parseInt(thresStatic);
			if (num == 0)
				num= 1;
			rewrite.setStaticOnDemandImportThreshold(num);
		} catch (NumberFormatException e) {
			// ignore
		}
		return rewrite;
	}

}