Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neoremind/result-util
Result code and message utility for Java programmer
https://github.com/neoremind/result-util
Last synced: about 2 months ago
JSON representation
Result code and message utility for Java programmer
- Host: GitHub
- URL: https://github.com/neoremind/result-util
- Owner: neoremind
- License: apache-2.0
- Created: 2016-12-18T10:01:13.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-12-18T14:03:47.000Z (about 8 years ago)
- Last Synced: 2024-10-12T06:19:59.759Z (3 months ago)
- Language: Java
- Homepage:
- Size: 40 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# result-util
[](https://travis-ci.org/neoremind/result-util)
[](https://coveralls.io/github/neoremind/result-util?branch=master)
[](https://maven-badges.herokuapp.com/maven-central/net.neoremind/result-util)
[](http://www.apache.org/licenses/LICENSE-2.0)
Result code and message utility for Java programmer
##Prerequisite
In order to use `result-util` in your project, simply add the following dependency. (Example is for maven pom.xml)
```
net.neoremind
result-util
1.0.0
```
Check out the lastest version on Maven Central.
By default, org.slf4j:slf4j-api:jar:1.7.7 and org.slf4j:slf4j-log4j12:jar:1.7.7 are used as logger.
You can switch to other slf4j implementation such as logback and exclude log4j like below:
```
net.neoremind
result-util
org.slf4j
slf4j-log4j12
```
## Usage
###1. Define result enum
For example, under `com.myproject` package.
```
import net.neoremind.resultutil.result.ResultCode;
import net.neoremind.resultutil.result.ResultCodeMessage;
import net.neoremind.resultutil.result.ResultCodeUtil;
public enum SampleResultCode implements ResultCode {
/**
* HTTP OK
*/
HTTP_SUCCESS,
/**
* HTTP Failed
*/
HTTP_FAILED,
/**
* Service failure
*/
SERVICE_FAILURE,
/**
* Data access failure
*/
DAO_FAILURE;
private final ResultCodeUtil util = new ResultCodeUtil(this);
public String getName() {
return util.getName();
}
public ResultCodeMessage getMessage() {
return util.getMessage();
}
public ResultCodeMessage getMessage(String args) {
return util.getMessage(args);
}
public int getCode() {
return util.getCode();
}
}
```
###2. Create XML resource file
**The XML file MUST be in the same class path and named the same filename as the `Enum` defined above**
For example, create a xml file named `SampleResultCode.xml` under `com/myproject` path.
```
Operation is successful
10001
Operation failed with HTTP CODE = {0}
10002
10003
Service failure
10004
DAO failure
```
###3. Start to use :-)
```
@Test
public void resultCode() {
ResultCode code = SampleResultCode.HTTP_SUCCESS;
Assert.assertEquals("HTTP_SUCCESS", code.getName());
Assert.assertEquals(10001, code.getCode());
Assert.assertEquals("Operation is successful", code.getMessage().getMessage());
}
@Test
public void resultCode2() {
SampleResultCode code = SampleResultCode.HTTP_FAILED;
Assert.assertEquals("HTTP_FAILED", code.getName());
Assert.assertEquals(10002, code.getCode());
Assert.assertEquals("Operation failed with HTTP CODE = THIS IS THE CAUSE", code.getMessage("THIS IS THE CAUSE").getMessage());
Assert.assertEquals("Operation failed with HTTP CODE = THIS IS THE CAUSE", SampleResultCode.HTTP_FAILED.getMessage("THIS IS THE CAUSE").getMessage());
}
```
##Dependencies
```
[INFO] +- org.slf4j:slf4j-api:jar:1.7.7:compile
[INFO] +- org.slf4j:slf4j-log4j12:jar:1.7.7:provided
[INFO] | \- log4j:log4j:jar:1.2.17:provided
[INFO] +- dom4j:dom4j:jar:1.6.1:compile
[INFO] | \- xml-apis:xml-apis:jar:1.0.b2:compile
[INFO] +- jaxen:jaxen:jar:1.1.1:compile
[INFO] | +- jdom:jdom:jar:1.0:compile
[INFO] | +- xerces:xercesImpl:jar:2.6.2:compile
[INFO] | \- xom:xom:jar:1.0:compile
[INFO] | +- xerces:xmlParserAPIs:jar:2.6.2:compile
[INFO] | +- xalan:xalan:jar:2.6.0:compile
[INFO] | \- com.ibm.icu:icu4j:jar:2.6.1:compile
```