jep.NamingConventionClassEnquirer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jep Show documentation
Show all versions of jep Show documentation
Jep embeds CPython in Java through JNI.
The newest version!
/**
* Copyright (c) 2015-2022 JEP AUTHORS.
*
* This file is licensed under the the zlib/libpng License.
*
* This software is provided 'as-is', without any express or implied
* warranty. In no event will the authors be held liable for any
* damages arising from the use of this software.
*
* Permission is granted to anyone to use this software for any
* purpose, including commercial applications, and to alter it and
* redistribute it freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you
* must not claim that you wrote the original software. If you use
* this software in a product, an acknowledgment in the product
* documentation would be appreciated but is not required.
*
* 2. Altered source versions must be plainly marked as such, and
* must not be misrepresented as being the original software.
*
* 3. This notice may not be removed or altered from any source
* distribution.
*/
package jep;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Set;
/**
*
* A simple {@link ClassEnquirer} to see if the package/class to be imported in
* a Python interpreter should be considered as a Java package/class. This
* enquirer can check for import statements beginning with java, com, gov, etc
* and country codes such as us, uk, fr, ch, etc.
*
*
* This class is useful for the following scenarios:
*
* - You don't want the overhead of initializing
* {@code ClassList.getInstance()}
* - You don't want all the classes in a package automatically imported
* - You don't have Python modules that resemble Java package names
*
*
* @author Nate Jensen
*
* @since 3.3
*/
public class NamingConventionClassEnquirer implements ClassEnquirer {
/**
* the default top level package names: java, javax, com, gov, org, edu,
* mil, net
*/
protected static final List TOP_LEVEL = Collections
.unmodifiableList(Arrays.asList("java", "javax", "com", "gov",
"org", "edu", "mil", "net"));
protected Set javaNames;
/**
* Convenience constructor. Includes defaults but not country codes.
*/
public NamingConventionClassEnquirer() {
this(true);
}
/**
* Constructor
*
* @param includeDefaults
* whether or not typical package names such as java, javax, com,
* gov should be considered as a java package.
*/
public NamingConventionClassEnquirer(boolean includeDefaults) {
this(includeDefaults, false);
}
/**
* Constructor
*
* @param includeDefaults
* whether or not typical package names such as java, javax, com,
* gov should be considered as a java package.
* @param includeCountryCodes
* whether or not a name starting with a 2-letter country code
* such a uk, de, fr, us, ch should be considered as a Java
* package.
*/
public NamingConventionClassEnquirer(boolean includeDefaults,
boolean includeCountryCodes) {
if (includeCountryCodes) {
String[] codes = Locale.getISOCountries();
if (includeDefaults) {
javaNames = new HashSet<>(codes.length + TOP_LEVEL.size());
javaNames.addAll(TOP_LEVEL);
} else {
javaNames = new HashSet<>(codes.length);
}
for (String country : codes) {
javaNames.add(country.toLowerCase());
}
for (String restrictedPkg : ClassEnquirer.RESTRICTED_PKG_NAMES) {
javaNames.remove(restrictedPkg);
}
} else if (includeDefaults) {
javaNames = new HashSet<>(TOP_LEVEL);
} else {
javaNames = new HashSet<>();
}
}
/**
* Adds a top level package name to the list of names that should be
* considered as Java packages
*
* @param pkgStart
* the start of a java package name to check, e.g. com, gov, us,
* it, fr
* @return this instance of the NamingConventionClassEnquirer to support the
* fluent interface pattern
*/
public NamingConventionClassEnquirer addTopLevelPackageName(
String pkgStart) {
javaNames.add(pkgStart);
return this;
}
@Override
public boolean isJavaPackage(String name) {
if (name == null) {
throw new IllegalArgumentException("name must not be null");
}
if (javaNames.contains(name)) {
return true;
}
String[] split = name.split("\\.");
int len = split.length;
return (len > 0 && javaNames.contains(split[0])
&& Character.isLowerCase(split[len - 1].charAt(0)));
}
@Override
public String[] getClassNames(String pkgName) {
return null;
}
@Override
public String[] getSubPackages(String pkgName) {
return null;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy