*****************************************************
Summary
-------
Generated at: 2024-10-02T10:03:03+02:00

Notes: 0
Binaries: 0
Archives: 0
Standards: 7

Apache Licensed: 2
Generated Documents: 0

JavaDocs are generated, thus a license header is optional.
Generated files do not require license headers.

5 Unknown Licenses

*****************************************************

Files with unapproved licenses:

  checkstyle-config.xml
  CODE_OF_CONDUCT.md
  CONTRIBUTING.md
  PMD.xml
  README.md

*****************************************************

*****************************************************
  Files with Apache License headers will be marked AL
  Binary files (which do not require any license headers) will be marked B
  Compressed archives will be marked A
  Notices, licenses etc. will be marked N
 !????? checkstyle-config.xml
 !????? CODE_OF_CONDUCT.md
 !????? CONTRIBUTING.md
  AL    LICENSE.md
 !????? PMD.xml
  AL    pom.xml
 !????? README.md
 
*****************************************************

 Printing headers for text files without a valid license header...
 
=====================================================
== File: checkstyle-config.xml
=====================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
  <property name="severity" value="warning"/>

  <module name="TreeWalker">
    <!-- Annotations -->
    <module name="AnnotationLocation">
      <property name="allowSamelineMultipleAnnotations" value="false"/>
      <property name="allowSamelineSingleParameterlessAnnotation" value="true"/>
      <property name="allowSamelineParameterizedAnnotation" value="false"/>
      <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, PACKAGE_DEF, ENUM_CONSTANT_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF, COMPACT_CTOR_DEF"/>
    </module>
    <!--
    <module name="AnnotationOnSameLine">
      <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF, COMPACT_CTOR_DEF"/>
    </module>
    -->
    <module name="AnnotationUseStyle">
      <property name="closingParens" value="never"/>
      <property name="elementStyle" value="compact"/>
      <property name="trailingArrayComma" value="never"/>
    </module>
    <module name="MissingDeprecated">
      <property name="violateExecutionOnNonTightHtml" value="false"/>
    </module>
    <module name="MissingOverride">
      <property name="javaFiveCompatibility" value="false"/>
    </module>
    <module name="PackageAnnotation">
    </module>
    <module name="SuppressWarnings">
      <property name="format" value="^\s*+$"/>
      <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF, ENUM_CONSTANT_DEF, PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, CTOR_DEF, COMPACT_CTOR_DEF, RECORD_DEF"/>
    </module>
    <module name="SuppressWarningsHolder">
      <property name="aliasList" value=""/>
    </module>

    <!-- Block Checks -->
    <module name="AvoidNestedBlocks">
      <property name="severity" value="warning"/>
      <property name="allowInSwitchCase" value="false"/>
    </module>
    <module name="EmptyBlock">
      <property name="severity" value="warning"/>
      <property name="option" value="text"/>
      <property name="tokens" value="LITERAL_WHILE, LITERAL_TRY, LITERAL_FINALLY, LITERAL_DO, LITERAL_IF, LITERAL_ELSE, LITERAL_FOR, INSTANCE_INIT, STATIC_INIT, LITERAL_SWITCH, LITERAL_SYNCHRONIZED"/>
    </module>
    <module name="EmptyCatchBlock">

=====================================================
== File: CODE_OF_CONDUCT.md
=====================================================
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
  advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
  address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
  professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official

=====================================================
== File: CONTRIBUTING.md
=====================================================
# How to contribute

## Code of Conduct

This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [powerstat@web.de](mailto:powerstat@web.de).

## I don't want to read this whole thing I just have a question!!!

> **Note:** Please don't file an issue to ask a question. You'll get faster results by using the resources below.

* [EMail](mailto:powerstat@web.de)

## How to report bugs or enhancements

### Reporting Bugs

#### Before Submitting A Bug Report

#### How Do I Submit A (Good) Bug Report?

### Suggesting Enhancements

#### Before Submitting An Enhancement Suggestion

#### How Do I Submit A (Good) Enhancement Suggestion?

## Design Decisions

## Styleguides

### Git Commit Messages

### Issue and Pull Request Labels

### Java Styleguide
#### Package Conventions
### PowerStat's TemplateEngine and Packages

### Documentation Styleguide

### Coding conventions

## How to set up your environment and run tests

## Testing

We have JUnit 5 based unittests, please write tests for new code you create.




=====================================================
== File: PMD.xml
=====================================================
<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="PowerStat Rules" xmlns="http://pmd.sourceforge.net/ruleset/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
  <description>This ruleset checks the code for discouraged programming constructs.</description>

  <!-- Apex Rules -->
  <!-- not used -->

  <!-- Ecmascript Rules -->
  <!-- Ecmascript best practices -->
  <rule ref="category/ecmascript/bestpractices.xml/AvoidWithStatement" />
  <rule ref="category/ecmascript/bestpractices.xml/ConsistentReturn" />
  <rule ref="category/ecmascript/bestpractices.xml/GlobalVariable" />
  <rule ref="category/ecmascript/bestpractices.xml/ScopeForInVariable" />
  <rule ref="category/ecmascript/bestpractices.xml/UseBaseWithParseInt" />

  <!-- Ecmascript code style -->
  <rule ref="category/ecmascript/codestyle.xml/AssignmentInOperand">
    <properties>
      <property name="allowIf" value="false" />
      <property name="allowFor" value="false" />
      <property name="allowWhile" value="false" />
      <property name="allowTernary" value="false" />
      <property name="allowTernaryResults" value="false" />
      <property name="allowIncrementDecrement" value="false" />
    </properties>
  </rule>
  <rule ref="category/ecmascript/codestyle.xml/ForLoopsMustUseBraces" />
  <rule ref="category/ecmascript/codestyle.xml/IfElseStmtsMustUseBraces" />
  <rule ref="category/ecmascript/codestyle.xml/IfStmtsMustUseBraces" />
  <rule ref="category/ecmascript/codestyle.xml/NoElseReturn" />
  <rule ref="category/ecmascript/codestyle.xml/UnnecessaryBlock" />
  <rule ref="category/ecmascript/codestyle.xml/UnnecessaryParentheses" />
  <rule ref="category/ecmascript/codestyle.xml/UnreachableCode" />
  <rule ref="category/ecmascript/codestyle.xml/WhileLoopsMustUseBraces" />

  <!-- Ecmascript error prone -->
  <rule ref="category/ecmascript/errorprone.xml/AvoidTrailingComma">
    <properties>
      <property name="allowObjectLiteral" value="false" />
      <property name="allowArrayLiteral" value="false" />
    </properties>
  </rule>
  <rule ref="category/ecmascript/errorprone.xml/EqualComparison" />
  <rule ref="category/ecmascript/errorprone.xml/InnaccurateNumericLiteral" />

  <!-- HTML Rules -->
  <!-- HTML best practices -->
  <!-- <rule ref="category/html/bestpractices.xml/AvoidInlineStyles" /> requires 6.45 -->
  <!-- <rule ref="category/html/bestpractices.xml/UnnecessaryTypeAttribute" /> requires 6.45 -->
  <!-- <rule ref="category/html/bestpractices.xml/UseAltAttributeForImages" /> requires 6.45 -->

=====================================================
== File: README.md
=====================================================
# PowerStat's Toolbaseline for Java

This is my [ToolbaselineJava](https://www.powerstat.de/ToolbaselineJava.html).

## Installation

Because this library is only useful for developers the installation depends on your build environment.

For example when using Apache Maven you could add the following dependency to your project:

    <dependency>
      <groupId>de.powerstat.toolbaseline</groupId>
      <artifactId>tbljava</artifactId>
      <version>17.1.0</version>
    </dependency>

Also please copy the `checkstyle-config.xml` and `PMD.xml` into your project.
Please add the following entry to your maven `settings.xml`:

    <server>
      <id>nvd</id>
      <password>nvd api-key</password>
    </server>

The API-Key could be requested here: [National Vulnerability Database](https://nvd.nist.gov/developers/request-an-api-key)


Other build tools like gradle will work analogous.

To compile this project yourself you could use:

    mvn clean install site
    
or simply:

     mvn clean install

or for native image creation:

On windows Visual Studio 2022 is required and you have to call:

    "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvars64.bat" > nul

Compile and build image:

    mvn clean -Pnative package
    
Run the image:

    ./target/[imagename]