Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skn437/skn-java-message

A Simple Message Library For Java
https://github.com/skn437/skn-java-message

gradle java library maven message

Last synced: 6 days ago
JSON representation

A Simple Message Library For Java

Awesome Lists containing this project

README

        

# SKN Java Message Library

java

> Java

[![Maven Central](https://img.shields.io/maven-central/v/best.skn/skn-java-message)](https://central.sonatype.com/artifact/best.skn/skn-java-message) [![Javadoc](https://javadoc.io/badge2/best.skn/skn-java-message/1.3.0/javadoc.svg)](https://javadoc.io/doc/best.skn/skn-java-message/1.3.0) [![Apache License 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

 

## **_JavaDocs:_**

### Read the Javadoc for the main API: [Message API](https://javadoc.io/doc/best.skn/skn-java-message/latest/best/skn/utils/message/Message.html)

 

## **_Introduction:_**

### This is a simple Java Library for notification message on console & server response

### I made this library so that I can use it in all of my java projects without writing the same codes over and over again

### The main API Class of this library is `Message` which holds 7 static methods to output notifications

 

## **_Details:_**

### **`Message` Class:**

- It doesn't need to be instantiated
- It has 10 static methods
- The notification modes are:
- Info message on console (It has new line character at the end)
- Info message as server response
- Info message as server mono response (Reactive)
- Success message on console (It has new line character at the end)
- Success message as server response
- Success message as server mono response (Reactive)
- Error message on console (It has new line character at the end)
- Error message as server response
- Error message as server mono response (Reactive)
- Instantiation Error message (Shows Java Unsupported Operation Exception)

 

## **_Use Case:_**

- Java
- Java Spring Boot

 

## **_Requirements:_**

- 💀 Minimum Java Version: `21`

 

## **_Usage:_**

### For `Maven`, inside `dependencies` tag of `pom.xml`, copy the following

> ```xml
>
> best.skn
> skn-java-message
> 1.3.0
>
> ```

### For `Gradle`, inside `dependencies` block of `build.gradle.kts`, copy the following

> ```kotlin
> implementation("best.skn:skn-java-message:1.3.0")
> ```

### Inside your Java Code, import the package like this

> ```java
> import best.skn.utils.message.Message;
> ```

### Use the package like this for normal cases

> ```java
> public class Cat {
> public Cat() {
> System.out.print(Message.infoConsole("Cat Class Instantiated!"));
> }
> }
> ```

### Use the package like this for `UnsupportedOperationException`

> ```java
> public class Person {
> private Person() {
> Message.throwInstantiationError();
> }
> }
> ```

 

## **_Dedicated To:_**

- 👩‍🎨`Prodipta Das Logno` & 🧛‍♀️`Atoshi Sarker Prithula`: The two most special ladies of my life. My best wishes will always be with you two. May you two always be happy.
- 💯`My Parents`: The greatest treasures of my life ever.

 

## **_License:_**

Copyright (C) 2024 SKN Shukhan

Licensed under the Apache License, Version 2.0