https://github.com/thiagogarbazza/violation-builder

A small java library for building violations.
https://github.com/thiagogarbazza/violation-builder

builder java violation violation-builder

Last synced: about 6 hours ago
JSON representation

A small java library for building violations.

• Host: GitHub
• URL: https://github.com/thiagogarbazza/violation-builder
• Owner: thiagogarbazza
• License: mit
• Created: 2019-07-22T20:32:40.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-06-24T13:33:39.000Z (over 2 years ago)
• Last Synced: 2024-04-16T07:05:45.904Z (7 months ago)
• Topics: builder, java, violation, violation-builder
• Language: Java
• Homepage:
• Size: 49.8 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# violation-builder

A small java library for building violations.

[![Build Status](https://api.travis-ci.com/thiagogarbazza/violation-builder.svg?branch=master)](https://app.travis-ci.com/thiagogarbazza/violation-builder)

[![Coverage Status](https://sonarcloud.io/api/project_badges/measure?project=com.github.thiagogarbazza:violation-builder&metric=alert_status)](https://sonarcloud.io/dashboard?id=com.github.thiagogarbazza:violation-builder)

[![Coverage Status](https://sonarcloud.io/api/project_badges/measure?project=com.github.thiagogarbazza:violation-builder&metric=coverage)](https://sonarcloud.io/dashboard?id=com.github.thiagogarbazza:violation-builder)

## Usage samples

```java

void example() throws ViolationException {

  boolean condition = true;

  ViolationBuilder.builder()

    .error(condition,"error-key", () -> "some error message.")

    .warning(condition,"waring-key", () -> "some warning message.")

    .buildIgnoreWarnings();

}

```

Appends to the builder a violations of error type.

```java

void example() throws ViolationException {

  boolean condition = true;

  ViolationBuilder.builder()

    .error(condition, "error-key-01", "some error-01 message.")

    .error("error-key-02", "some error-02 message.")

    .error(condition,"error-key-03", () -> "some error-03 message.")

    .error("error-key-04", () -> "some error-04 message.")

    .build();

}

```

Appends to the builder a violations of warning type.

```java

void example() throws ViolationException {

  boolean condition = true;

  ViolationBuilder.builder()

    .warning(condition, "waring-key-01", "some waring-01 message.")

    .warning("waring-key-02", "some waring-02 message.")

    .warning(condition,"waring-key-03", () -> "some warning-03 message.")

    .warning("waring-key-04", () -> "some warning-04 message.")

    .build();

}

```

Executing a collection of validation rules

```java

final Collection> rules = Arrays.asList(

  new ValidationRuleContinueFlow() {

    @Override

    public void runContinueFlow(ViolationBuilder violationBuilder, Object data) {

      violationBuilder.warning(/* validation on the data */, "waring-key-01", "some waring-01 message.");

    }

  },

  new ValidationRuleStopFlow() {

    @Override

    public void runStopFlow(ViolationBuilder violationBuilder, Object data) {

      violationBuilder.error(/* validation on the data */, "error-key-01", "some error-01 message.");

    }

  },

  new ValidationRuleContinueFlow() {

    @Override

    public void runContinueFlow(ViolationBuilder violationBuilder, Object data) {

      violationBuilder.error(/* validation on the data */, "error-key-02", "some error-02 message.");

    }

  },

  new ValidationRule() {

    @Override

    public Rulesflow run(ViolationBuilder violationBuilder, Object data) {

      violationBuilder.error(/* validation on the data */, "error-key-03", "some error-03 message.");

      return Rulesflow.CONTINUE;

    }

  }

);

RulesExecutor.rulesExecutor(rules, data);

```

## Installing

Available in the [Maven Central repository].

Add a dependency to `com.github.thiagogarbazza:violation-builder` in your project.

Example using maven:

```xml

  com.github.thiagogarbazza

  violation-builder

  1.2.0

```

## Built With

- [Java](https://www.java.com/) - The lang used

- [Junit](https://junit.org/junit5/) - The framework test used

- [Maven](https://maven.apache.org/) - Dependency Management

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository].

## Authors

- **[Thiago Garbazza](https://github.com/thiagogarbazza)** - *Initial work*

See also the list of [contributors] who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

## Acknowledgments

- Java 8+

- Junit jupter

[contributors]: (https://github.com/thiagogarbazza/violation-builder/contributors)

[tags on this repository]: https://github.com/thiagogarbazza/violation-builder/tags

[Maven Central repository]: http://mvnrepository.com/artifact/com.github.thiagogarbazza/violation-builder