Java AuditEvent类代码示例

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
@Override
public void addError(AuditEvent event) {
    final String ruleKey = getRuleKey(event);
    if (ruleKey != null) {
        final String message = getMessage(event);
        // In Checkstyle 5.5 exceptions are reported as an events from
        // TreeWalker
        if ("com.puppycrawl.tools.checkstyle.TreeWalker".equals(ruleKey)) {
            LOG.warn("{} : {}", event.getFileName(), message);
        }
        initResource(event);
        final Issuable issuable = perspectives.as(Issuable.class, currentResource);
        final Rule rule = ruleFinder.findByKey(CheckstyleConstants.REPOSITORY_KEY, ruleKey);
        if (rule != null && issuable != null) {
            final IssueBuilder issueBuilder = issuable.newIssueBuilder().ruleKey(rule.ruleKey())
                    .message(message).line(getLineId(event));
            issuable.addIssue(issueBuilder.build());
        }
    }
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
/**
 * Checks for a suppression of a check with the given source name and
 * location in the last file processed.
 * @param event audit event.
 * @return whether the check with the given name is suppressed at the given
 *         source location
 */
public static boolean isSuppressed(AuditEvent event) {
    final List<Entry> entries = ENTRIES.get();
    final String sourceName = event.getSourceName();
    final String checkAlias = getAlias(sourceName);
    final int line = event.getLine();
    final int column = event.getColumn();
    boolean suppressed = false;
    for (Entry entry : entries) {
        final boolean afterStart = isSuppressedAfterEventStart(line, column, entry);
        final boolean beforeEnd = isSuppressedBeforeEventEnd(line, column, entry);
        final boolean nameMatches =
            ALL_WARNING_MATCHING_ID.equals(entry.getCheckName())
                || entry.getCheckName().equalsIgnoreCase(checkAlias);
        final boolean idMatches = event.getModuleId() != null
            && event.getModuleId().equals(entry.getCheckName());
        if (afterStart && beforeEnd && (nameMatches || idMatches)) {
            suppressed = true;
            break;
        }
    }
    return suppressed;
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
/**
 * Outputs the given event to the writer.
 * @param event An event to print.
 */
private void writeFileError(AuditEvent event) {
    writer.print("<error" + " line=\"" + event.getLine() + "\"");
    if (event.getColumn() > 0) {
        writer.print(" column=\"" + event.getColumn() + "\"");
    }
    writer.print(" severity=\""
            + event.getSeverityLevel().getName()
            + "\"");
    writer.print(" message=\""
            + encode(event.getMessage())
            + "\"");
    writer.print(" source=\"");
    if (event.getModuleId() == null) {
        writer.print(encode(event.getSourceName()));
    }
    else {
        writer.print(encode(event.getModuleId()));
    }
    writer.println("\"/>");
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
/**
 * Returns check name without 'Check' suffix.
 * @param event audit event.
 * @return check name without 'Check' suffix.
 */
private static String getCheckShortName(AuditEvent event) {
    final String checkFullName = event.getSourceName();
    final String checkShortName;
    final int lastDotIndex = checkFullName.lastIndexOf('.');
    if (lastDotIndex == -1) {
        if (checkFullName.endsWith(SUFFIX)) {
            checkShortName = checkFullName.substring(0, checkFullName.lastIndexOf(SUFFIX));
        }
        else {
            checkShortName = checkFullName.substring(0, checkFullName.length());
        }
    }
    else {
        if (checkFullName.endsWith(SUFFIX)) {
            checkShortName = checkFullName.substring(lastDotIndex + 1,
                checkFullName.lastIndexOf(SUFFIX));
        }
        else {
            checkShortName = checkFullName.substring(lastDotIndex + 1, checkFullName.length());
        }
    }
    return checkShortName;
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
/**
 * Checks whether the suppression matches the given {@link AuditEvent}.
 * @param event {@link AuditEvent} instance.
 * @return true if the suppression matches {@link AuditEvent}.
 */
private boolean isMatch(AuditEvent event) {
    boolean match = false;
    if (isInScopeOfSuppression(event)) {
        final Matcher sourceNameMatcher = eventSourceRegexp.matcher(event.getSourceName());
        if (sourceNameMatcher.find()) {
            match = eventMessageRegexp == null
                || eventMessageRegexp.matcher(event.getMessage()).find();
        }
        else {
            match = event.getModuleId() != null
                && eventSourceRegexp.matcher(event.getModuleId()).find();
        }
    }
    return match;
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
/**
 * Notify all listeners about the errors in a file.
 *
 * @param fileName the audited file
 * @param errors the audit errors from the file
 */
@Override
public void fireErrors(String fileName, SortedSet<LocalizedMessage> errors) {
    final String stripped = CommonUtils.relativizeAndNormalizePath(basedir, fileName);
    boolean hasNonFilteredViolations = false;
    for (final LocalizedMessage element : errors) {
        final AuditEvent event = new AuditEvent(this, stripped, element);
        if (filters.accept(event)) {
            hasNonFilteredViolations = true;
            for (final AuditListener listener : listeners) {
                listener.addError(event);
            }
        }
    }
    if (hasNonFilteredViolations && cache != null) {
        cache.remove(fileName);
    }
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
@Test
public void testIsSuppressedWithAllArgument() throws Exception {
    createHolder("all", 100, 100, 350, 350);

    final Checker source = new Checker();
    final LocalizedMessage firstMessageForTest =
        new LocalizedMessage(100, 10, null, null, null, "id", MemberNameCheck.class, "msg");
    final AuditEvent firstEventForTest =
        new AuditEvent(source, "fileName", firstMessageForTest);
    assertFalse("Event is suppressed",
            SuppressWarningsHolder.isSuppressed(firstEventForTest));

    final LocalizedMessage secondMessageForTest =
        new LocalizedMessage(100, 150, null, null, null, "id", MemberNameCheck.class, "msg");
    final AuditEvent secondEventForTest =
        new AuditEvent(source, "fileName", secondMessageForTest);
    assertTrue("Event is not suppressed",
            SuppressWarningsHolder.isSuppressed(secondEventForTest));

    final LocalizedMessage thirdMessageForTest =
        new LocalizedMessage(200, 1, null, null, null, "id", MemberNameCheck.class, "msg");
    final AuditEvent thirdEventForTest =
        new AuditEvent(source, "fileName", thirdMessageForTest);
    assertTrue("Event is not suppressed",
            SuppressWarningsHolder.isSuppressed(thirdEventForTest));
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
@Test
public void testAcceptOnMatch() {
    filter.setSeverity(SeverityLevel.INFO);
    filter.setAcceptOnMatch(false);
    final AuditEvent ev = new AuditEvent(this, "Test.java");
    // event with no message has severity level INFO
    assertFalse("no message", filter.accept(ev));
    final SeverityLevel errorLevel = SeverityLevel.ERROR;
    final LocalizedMessage errorMessage =
        new LocalizedMessage(0, 0, "", "", null,
            errorLevel, null, getClass(), null);
    final AuditEvent ev2 = new AuditEvent(this, "ATest.java", errorMessage);
    assertTrue("level:" + errorLevel, filter.accept(ev2));
    final SeverityLevel infoLevel = SeverityLevel.INFO;
    final LocalizedMessage infoMessage = new LocalizedMessage(0, 0, "", "", null, infoLevel,
        null, getClass(), null);
    final AuditEvent ev3 = new AuditEvent(this, "ATest.java", infoMessage);
    assertFalse("level:" + infoLevel, filter.accept(ev3));
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
@Test
public void testAddErrorOnZeroColumns() throws Exception {
    final XMLLogger logger = new XMLLogger(outStream, true);
    logger.auditStarted(null);
    final LocalizedMessage message =
            new LocalizedMessage(1, 0,
                    "messages.properties", "key", null, SeverityLevel.ERROR, null,
                    getClass(), null);
    final AuditEvent ev = new AuditEvent(this, "Test.java", message);
    logger.fileStarted(ev);
    logger.addError(ev);
    logger.fileFinished(ev);
    logger.auditFinished(null);
    verifyXml(getPath("ExpectedXMLLoggerErrorZeroColumn.xml"), outStream,
            message.getMessage());
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
@Test
public void testAddExceptionAfterFileStarted()
        throws Exception {
    final XMLLogger logger = new XMLLogger(outStream, true);
    logger.auditStarted(null);

    final AuditEvent fileStartedEvent = new AuditEvent(this, "Test.java");
    logger.fileStarted(fileStartedEvent);

    final LocalizedMessage message =
            new LocalizedMessage(1, 1,
                    "messages.properties", null, null, null, getClass(), null);
    final AuditEvent ev = new AuditEvent(this, "Test.java", message);
    logger.addException(ev, new TestException("msg", new RuntimeException("msg")));

    logger.fileFinished(ev);
    logger.auditFinished(null);
    verifyXml(getPath("ExpectedXMLLoggerException2.xml"), outStream);
    assertEquals("Invalid close count", 1, outStream.getCloseCount());
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
@Test
public void testAddExceptionBeforeFileFinished()
        throws Exception {
    final XMLLogger logger = new XMLLogger(outStream, true);
    logger.auditStarted(null);
    final LocalizedMessage message =
            new LocalizedMessage(1, 1,
                    "messages.properties", null, null, null, getClass(), null);
    final AuditEvent ev = new AuditEvent(this, "Test.java", message);
    logger.addException(ev, new TestException("msg", new RuntimeException("msg")));
    final AuditEvent fileFinishedEvent = new AuditEvent(this, "Test.java");
    logger.fileFinished(fileFinishedEvent);
    logger.auditFinished(null);
    verifyXml(getPath("ExpectedXMLLoggerException3.xml"), outStream);
    assertEquals("Invalid close count", 1, outStream.getCloseCount());
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
@Test
public void testAddExceptionBetweenFileStartedAndFinished()
        throws Exception {
    final XMLLogger logger = new XMLLogger(outStream, true);
    logger.auditStarted(null);
    final LocalizedMessage message =
            new LocalizedMessage(1, 1,
                    "messages.properties", null, null, null, getClass(), null);
    final AuditEvent fileStartedEvent = new AuditEvent(this, "Test.java");
    logger.fileStarted(fileStartedEvent);
    final AuditEvent ev = new AuditEvent(this, "Test.java", message);
    logger.addException(ev, new TestException("msg", new RuntimeException("msg")));
    final AuditEvent fileFinishedEvent = new AuditEvent(this, "Test.java");
    logger.fileFinished(fileFinishedEvent);
    logger.auditFinished(null);
    verifyXml(getPath("ExpectedXMLLoggerException2.xml"), outStream);
    assertEquals("Invalid close count", 1, outStream.getCloseCount());
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
@Test
public void testCtor() throws UnsupportedEncodingException {
    final OutputStream infoStream = new ByteArrayOutputStream();
    final ByteArrayOutputStream errorStream = new ByteArrayOutputStream();
    final DefaultLogger dl = new DefaultLogger(infoStream, true, errorStream, true);
    dl.addException(new AuditEvent(5000, "myfile"), new IllegalStateException("upsss"));
    dl.auditFinished(new AuditEvent(6000, "myfile"));
    final String output = errorStream.toString(StandardCharsets.UTF_8.name());
    final LocalizedMessage addExceptionMessage = new LocalizedMessage(0,
            Definitions.CHECKSTYLE_BUNDLE, DefaultLogger.ADD_EXCEPTION_MESSAGE,
            new String[] {"myfile"}, null,
            getClass(), null);

    assertTrue("Invalid exception", output.contains(addExceptionMessage.getMessage()));
    assertTrue("Invalid exception class",
        output.contains("java.lang.IllegalStateException: upsss"));
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
@Test
public void testAcceptThrowsIllegalStateExceptionAsFileNotFound() {
    final LocalizedMessage message = new LocalizedMessage(1, 1, 1, TokenTypes.CLASS_DEF,
        "messages.properties", "key", null, SeverityLevel.ERROR, null, getClass(), null);
    final String fileName = "nonexisting_file";
    final AuditEvent auditEvent = new AuditEvent(this, fileName, message);

    final SuppressWithPlainTextCommentFilter filter = new SuppressWithPlainTextCommentFilter();

    try {
        filter.accept(auditEvent);
        fail(IllegalStateException.class.getSimpleName() + " is expected");
    }
    catch (IllegalStateException ex) {
        assertEquals("Invalid exception message",
            "Cannot read source file: " + fileName, ex.getMessage());

        final Throwable cause = ex.getCause();
        assertTrue("Exception cause has invalid type",
            cause instanceof FileNotFoundException);
        assertEquals("Invalid exception message",
            fileName + " (No such file or directory)", cause.getMessage());
    }
}
 

import com.puppycrawl.tools.checkstyle.api.AuditEvent; //导入依赖的package包/类
@Override
public String format(AuditEvent event) {
    final String fileName = event.getFileName();
    final String message = event.getMessage();

    // avoid StringBuffer.expandCapacity
    final int bufLen = event.getFileName().length() + event.getMessage().length()
        + LENGTH_OF_ALL_SEPARATORS;
    final StringBuilder sb = new StringBuilder(bufLen);

    sb.append(fileName).append(':').append(event.getLine());
    if (event.getColumn() > 0) {
        sb.append(':').append(event.getColumn());
    }
    sb.append(": ").append(message);

    return sb.toString();
}