findbugs.slf4j.bug-pattern.1.4.1.source-code.messages.xml Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bug-pattern Show documentation
There is a newer version: 1.5.0
<?xml version="1.0" encoding="UTF-8"?>
<MessageCollection xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation="messagecollection.xsd">

  <Plugin>
    <ShortDescription>FindBugs SLF4J Plugin</ShortDescription>
    <Details>This plugin provides detector for SLF4J</Details>
  </Plugin>

  <Detector class="jp.skypencil.findbugs.slf4j.WrongPlaceholderDetector">
    <Details>
      Finds message format which has wrong format string.
    </Details>
  </Detector>

  <Detector class="jp.skypencil.findbugs.slf4j.PublishedLoggerDetector">
    <Details>
      Finds published logger field.
    </Details>
  </Detector>

  <Detector class="jp.skypencil.findbugs.slf4j.NonFinalLoggerDetector">
    <Details>
      Finds non-final logger field.
    </Details>
  </Detector>

  <Detector class="jp.skypencil.findbugs.slf4j.StaticLoggerDetector">
    <Details>
      Finds static logger field.
    </Details>
  </Detector>

  <Detector class="jp.skypencil.findbugs.slf4j.IllegalPassedClassDetector">
    <Details>
      Finds illegal class which is passed to LoggerFactory#getLogger(Class)
    </Details>
  </Detector>

  <Detector class="jp.skypencil.findbugs.slf4j.ManualMessageDetector">
    <Details>
      Finds log which uses message returned from Throwable#getMessage and Throwable#getLocalizedMessage.
    </Details>
  </Detector>

  <BugPattern type="SLF4J_PLACE_HOLDER_MISMATCH">
    <ShortDescription>Count of placeholder is not equal to count of parameter</ShortDescription>
    <LongDescription>Count of placeholder({5}) is not equal to count of parameter({4})</LongDescription>
    <Details>
<![CDATA[
<p>Count of placeholder should equal to count of parameter.</p>
]]>
    </Details>
  </BugPattern>

  <BugPattern type="SLF4J_FORMAT_SHOULD_BE_CONST">
    <ShortDescription>Format should be constant</ShortDescription>
    <LongDescription>Format should be constant. Use placeholder to reduce the needless cost of parameter construction. see http://www.slf4j.org/faq.html#logging_performance</LongDescription>
    <Details>
<![CDATA[
<p>Format should be constant. Use placeholder to reduce the needless cost of parameter construction. see <a href="http://www.slf4j.org/faq.html#logging_performance">official FAQ</a>.</p>
]]>
    </Details>
  </BugPattern>

  <BugPattern type="SLF4J_UNKNOWN_ARRAY">
    <ShortDescription>Using unknown array as parameter</ShortDescription>
    <LongDescription>
      Using unknown array as parameter. You cannot use array which is provided as method argument or returned from other method, for better static analysis by findbugs-slf4j.
    </LongDescription>
    <Details>
<![CDATA[
<p>Using unknown array as parameter.
You cannot use array which is provided as method argument or returned from other method, for better static analysis by findbugs-slf4j.</p>
]]>
    </Details>
  </BugPattern>

  <BugPattern type="SLF4J_SIGN_ONLY_FORMAT">
    <ShortDescription>Log format should contain non-sign character</ShortDescription>
    <LongDescription>To make log readable, log format ({4}) should contain non-sign character.</LongDescription>
    <Details>
<![CDATA[
<p>To make log readable, log format should contain non-sign character.</p>
]]>
    </Details>
  </BugPattern>

  <BugPattern type="SLF4J_LOGGER_SHOULD_BE_PRIVATE">
    <ShortDescription>Logger should be private field</ShortDescription>
    <LongDescription>
      To prevent illegal usage, logger should be private field. Change this field ({0}) to private field.
    </LongDescription>
    <Details>
<![CDATA[
<p>To prevent illegal usage, logger should be private field.</p>
]]>
    </Details>
  </BugPattern>

  <BugPattern type="SLF4J_LOGGER_SHOULD_BE_FINAL">
    <ShortDescription>Logger should be final field</ShortDescription>
    <LongDescription>
      Logger should be final field. Change this field ({0}) to final field.
    </LongDescription>
    <Details>
<![CDATA[
<p>Logger should be final field.</p>
]]>
    </Details>
  </BugPattern>

  <BugPattern type="SLF4J_LOGGER_SHOULD_BE_NON_STATIC">
    <ShortDescription>Logger should be non-static field</ShortDescription>
    <LongDescription>
      Logger should be non-static field. Change this field ({0}) to non-static field.
    </LongDescription>
    <Details>
<![CDATA[
<p>Logger should be non-static field.</p>
]]>
    </Details>
  </BugPattern>

  <BugPattern type="SLF4J_ILLEGAL_PASSED_CLASS">
    <ShortDescription>Illegal class is passed to LoggerFactory#getLogger(Class)</ShortDescription>
    <LongDescription>
      Illegal class is passed to LoggerFactory#getLogger(Class). It should be one of {0}.
    </LongDescription>
    <Details>
<![CDATA[
<p>Illegal class is passed to LoggerFactory#getLogger(Class).</p>
]]>
    </Details>
  </BugPattern>

  <BugPattern type="SLF4J_MANUALLY_PROVIDED_MESSAGE">
    <ShortDescription>Do not have to use message returned from Throwable#getMessage and Throwable#getLocalizedMessage.</ShortDescription>
    <LongDescription>
      Do not have to use message returned from Throwable#getMessage and Throwable#getLocalizedMessage. It is enough to provide throwable instance as the last argument, then binding will log its message.
    </LongDescription>
    <Details>
<![CDATA[
<p>Do not have to use message returned from Throwable#getMessage and Throwable#getLocalizedMessage.</p>
]]>
    </Details>
  </BugPattern>

  <BugCode abbrev="SLF4J">SLF4J</BugCode>
</MessageCollection>