Java Configuration类代码示例

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
/**
 * Instantiates, configures and registers a Check that is specified
 * in the provided configuration.
 * @see com.puppycrawl.tools.checkstyle.api.AutomaticBean
 */
public void setupChild(Configuration aChildConf)
    throws CheckstyleException
{
    // TODO: improve the error handing
    final String name = aChildConf.getName();
    final Object module = mModuleFactory.createModule(name);
    if (!(module instanceof AbstractCheckVisitor)) {
        throw new CheckstyleException(
            "ClassFileSet is not allowed as a parent of " + name);
    }
    final AbstractCheckVisitor c = (AbstractCheckVisitor) module;
    c.contextualize(mChildContext);
    c.configure(aChildConf);
    c.init();

    registerCheck(c);
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
@SuppressWarnings("unchecked")
@Test
public void getCheckstyleConfiguration() throws Exception {
    fileSystem.setEncoding(StandardCharsets.UTF_8);
    final Settings settings = new Settings(new PropertyDefinitions(
            new CheckstylePlugin().getExtensions()));
    settings.setProperty(CheckstyleConstants.CHECKER_FILTERS_KEY,
            CheckstyleConstants.CHECKER_FILTERS_DEFAULT_VALUE);

    final RulesProfile profile = RulesProfile.create("sonar way", "java");

    final Rule rule = Rule.create("checkstyle", "CheckStyleRule1", "checkstyle rule one");
    rule.setConfigKey("checkstyle/rule1");
    profile.activateRule(rule, null);

    final CheckstyleConfiguration configuration = new CheckstyleConfiguration(settings,
            new CheckstyleProfileExporter(settings), profile, fileSystem);
    final Configuration checkstyleConfiguration = configuration.getCheckstyleConfiguration();
    assertThat(checkstyleConfiguration).isNotNull();
    assertThat(checkstyleConfiguration.getAttribute("charset")).isEqualTo("UTF-8");
    final File xmlFile = new File("checkstyle.xml");
    assertThat(xmlFile.exists()).isTrue();

    FileUtils.forceDelete(xmlFile);
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
@Test
public void testEmptyForLoop() throws Exception {

    final Class<NoWhitespaceBeforeCheck> clazz = NoWhitespaceBeforeCheck.class;
    final String messageKeyPreceded = "ws.preceded";

    final String[] expected = {
        "12:23: " + getCheckMessage(clazz, messageKeyPreceded, ";"),
        "18:31: " + getCheckMessage(clazz, messageKeyPreceded, ";"),
    };
    final Configuration checkConfig = getModuleConfig("NoWhitespaceBefore");
    final String filePath = getPath("InputNoWhitespaceBeforeEmptyForLoop.java");

    final Integer[] warnList = getLinesWithWarn(filePath);
    verify(checkConfig, filePath, expected, warnList);
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
@Test
public void testExternalResourceIsSavedInCache() throws Exception {
    final Configuration config = new DefaultConfiguration("myName");
    final String filePath = temporaryFolder.newFile().getPath();
    final PropertyCacheFile cache = new PropertyCacheFile(config, filePath);

    cache.load();

    final Set<String> resources = new HashSet<String>();
    final String pathToResource = getPath("InputPropertyCacheFileExternal.properties");
    resources.add(pathToResource);
    cache.putExternalResources(resources);

    final MessageDigest digest = MessageDigest.getInstance("SHA-1");
    final URI uri = CommonUtils.getUriByFilename(pathToResource);
    final byte[] input =
            ByteStreams.toByteArray(new BufferedInputStream(uri.toURL().openStream()));
    final ByteArrayOutputStream out = new ByteArrayOutputStream();
    final ObjectOutputStream oos = new ObjectOutputStream(out);
    oos.writeObject(input);
    digest.update(out.toByteArray());
    final String expected = BaseEncoding.base16().upperCase().encode(digest.digest());

    assertEquals("Hashes are not equal", expected,
            cache.get("module-resource*?:" + pathToResource));
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
@Test
public void testEmptyBlockCatch() throws Exception {

    final String[] expected = {
        "28: " + getCheckMessage(EmptyCatchBlockCheck.class, "catch.block.empty"),
        "49: " + getCheckMessage(EmptyCatchBlockCheck.class, "catch.block.empty"),
        "71: " + getCheckMessage(EmptyCatchBlockCheck.class, "catch.block.empty"),
        "79: " + getCheckMessage(EmptyCatchBlockCheck.class, "catch.block.empty"),
        "83: " + getCheckMessage(EmptyCatchBlockCheck.class, "catch.block.empty"),
    };

    final Configuration checkConfig = getModuleConfig("EmptyCatchBlock");
    final String filePath = getPath("InputEmptyBlockCatch.java");

    final Integer[] warnList = getLinesWithWarn(filePath);
    verify(checkConfig, filePath, expected, warnList);
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
/**
 * Creates {@link Checker} instance based on the given {@link Configuration} instance.
 * @param moduleConfig {@link Configuration} instance.
 * @return {@link Checker} instance based on the given {@link Configuration} instance.
 * @throws Exception if an exception occurs during checker configuration.
 */
public final Checker createChecker(Configuration moduleConfig)
        throws Exception {
    if (checkstyleModules == null) {
        checkstyleModules = CheckUtil.getCheckstyleModules();
    }

    final String name = moduleConfig.getName();
    ModuleCreationOption moduleCreationOption = ModuleCreationOption.IN_CHECKER;

    for (Class<?> moduleClass : checkstyleModules) {
        if (moduleClass.getSimpleName().equals(name)
                || moduleClass.getSimpleName().equals(name + "Check")) {
            if (ModuleReflectionUtils.isCheckstyleTreeWalkerCheck(moduleClass)
                    || ModuleReflectionUtils.isTreeWalkerFilterModule(moduleClass)) {
                moduleCreationOption = ModuleCreationOption.IN_TREEWALKER;
            }
            break;
        }
    }

    return createChecker(moduleConfig, moduleCreationOption);
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
@Test
public void testFlushAndCloseCacheFileOutputStream() throws IOException {
    mockStatic(Closeables.class);
    doNothing().when(Closeables.class);
    Closeables.close(any(FileOutputStream.class), Matchers.eq(false));
    mockStatic(Flushables.class);
    doNothing().when(Flushables.class);
    Flushables.flush(any(FileOutputStream.class), Matchers.eq(false));

    final Configuration config = new DefaultConfiguration("myName");
    final PropertyCacheFile cache = new PropertyCacheFile(config,
        temporaryFolder.newFile().getPath());

    cache.put("CheckedFileName.java", System.currentTimeMillis());
    cache.persist();

    verifyStatic(times(1));
    Closeables.close(any(FileOutputStream.class), Matchers.eq(false));
    verifyStatic(times(1));
    Flushables.flush(any(FileOutputStream.class), Matchers.eq(false));
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
@Test
public void testClassDefault() throws Exception {
    final Configuration configuration = getModuleConfig("ClassTypeParameterName");
    final String format = configuration.getAttribute("format");

    final String[] expected = {
        "5:31: " + getCheckMessage(configuration.getMessages(), MSG_KEY, "t", format),
        "13:14: " + getCheckMessage(configuration.getMessages(), MSG_KEY, "foo", format),
        "27:24: " + getCheckMessage(configuration.getMessages(), MSG_KEY, "$foo", format),
    };

    final String filePath = getPath("InputClassTypeParameterName.java");

    final Integer[] warnList = getLinesWithWarn(filePath);
    verify(configuration, filePath, expected, warnList);
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
@Test
public void testInterfaceDefault() throws Exception {
    final Configuration configuration = getModuleConfig("InterfaceTypeParameterName");
    final String format = configuration.getAttribute("format");

    final String[] expected = {
        "48:15: " + getCheckMessage(configuration.getMessages(), MSG_KEY, "Input", format),
        "76:25: " + getCheckMessage(configuration.getMessages(), MSG_KEY, "Request", format),
        "80:25: " + getCheckMessage(configuration.getMessages(), MSG_KEY, "TRequest", format),
    };

    final String filePath = getPath("InputInterfaceTypeParameterName.java");

    final Integer[] warnList = getLinesWithWarn(filePath);
    verify(configuration, filePath, expected, warnList);
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
@Test
public void testEmptyLineSeparator() throws Exception {

    final Class<EmptyLineSeparatorCheck> clazz = EmptyLineSeparatorCheck.class;
    final String messageKey = "empty.line.separator";

    final String[] expected = {
        "19: " + getCheckMessage(clazz, messageKey, "package"),
        "20: " + getCheckMessage(clazz, messageKey, "import"),
        "33: " + getCheckMessage(clazz, messageKey, "CLASS_DEF"),
        "37: " + getCheckMessage(clazz, messageKey, "STATIC_INIT"),
        "66: " + getCheckMessage(clazz, messageKey, "METHOD_DEF"),
        "75: " + getCheckMessage(clazz, messageKey, "INTERFACE_DEF"),
        "82: " + getCheckMessage(clazz, messageKey, "INSTANCE_INIT"),
        "113: " + getCheckMessage(clazz, messageKey, "CLASS_DEF"),
        "119: " + getCheckMessage(clazz, messageKey, "VARIABLE_DEF"),
    };

    final Configuration checkConfig = getModuleConfig("EmptyLineSeparator");
    final String filePath = getPath("InputEmptyLineSeparator.java");

    final Integer[] warnList = getLinesWithWarn(filePath);
    verify(checkConfig, filePath, expected, warnList);
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
@Test
public void testBadPackageName() throws Exception {

    final String packagePath =
            "com.google.checkstyle.test.chapter5naming.rule521packageNamesCamelCase";
    final Configuration checkConfig = getModuleConfig("PackageName");
    final String format = checkConfig.getAttribute("format");
    final String msg = getCheckMessage(checkConfig.getMessages(), MSG_KEY, packagePath, format);

    final String[] expected = {
        "1:9: " + msg,
    };

    final String filePath = getPath("packageNamesCamelCase", "InputPackageNameBad.java");

    final Integer[] warnList = getLinesWithWarn(filePath);
    verify(checkConfig, filePath, expected, warnList);
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
@Test
public void testBadPackageName2() throws Exception {

    final String packagePath = "com.google.checkstyle.test.chapter5naming.rule521_packagenames";
    final Configuration checkConfig = getModuleConfig("PackageName");
    final String format = checkConfig.getAttribute("format");
    final String msg = getCheckMessage(checkConfig.getMessages(), MSG_KEY, packagePath, format);

    final String[] expected = {
        "1:9: " + msg,
    };

    final String filePath = getPath("_packagenames", "InputBadPackageName2.java");

    final Integer[] warnList = getLinesWithWarn(filePath);
    verify(checkConfig, filePath, expected, warnList);
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
@Test
public void testBadPackageName3() throws Exception {

    final String packagePath = "com.google.checkstyle.test.chapter5naming.rule521$packagenames";
    final Configuration checkConfig = getModuleConfig("PackageName");
    final String format = checkConfig.getAttribute("format");
    final String msg = getCheckMessage(checkConfig.getMessages(), MSG_KEY, packagePath, format);

    final String[] expected = {
        "1:9: " + msg,
    };

    final String filePath = getPath("$packagenames", "InputPackageBadName3.java");

    final Integer[] warnList = getLinesWithWarn(filePath);
    verify(checkConfig, filePath, expected, warnList);
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
@Test
public void testCustomMessages() throws Exception {
    final Properties props = new Properties();
    props.setProperty("checkstyle.basedir", "basedir");

    final DefaultConfiguration config =
        (DefaultConfiguration) loadConfiguration(
            "InputConfigurationLoaderCustomMessages.xml", props);

    final Configuration[] children = config.getChildren();
    final Configuration[] grandchildren = children[0].getChildren();

    final String expectedKey = "name.invalidPattern";
    assertTrue("Messages should contain key: " + expectedKey,
        grandchildren[0].getMessages()
        .containsKey(expectedKey));
}
 

import com.puppycrawl.tools.checkstyle.api.Configuration; //导入依赖的package包/类
@Test
public void testUnicodeEscapes() throws Exception {

    final String[] expected = {
        "5: " + getCheckMessage(AvoidEscapedUnicodeCharactersCheck.class, MSG_KEY),
        "15: " + getCheckMessage(AvoidEscapedUnicodeCharactersCheck.class, MSG_KEY),
        "25: " + getCheckMessage(AvoidEscapedUnicodeCharactersCheck.class, MSG_KEY),
        "33: " + getCheckMessage(AvoidEscapedUnicodeCharactersCheck.class, MSG_KEY),
        "35: " + getCheckMessage(AvoidEscapedUnicodeCharactersCheck.class, MSG_KEY),
        "36: " + getCheckMessage(AvoidEscapedUnicodeCharactersCheck.class, MSG_KEY),
    };

    final Configuration checkConfig = getModuleConfig("AvoidEscapedUnicodeCharacters");
    final String filePath = getPath("InputAvoidEscapedUnicodeCharacters.java");

    final Integer[] warnList = getLinesWithWarn(filePath);
    verify(checkConfig, filePath, expected, warnList);
}