[jsemver] 92/95: Add Exception Handling section to README

Alexandre Viau reazem-guest at moszumanska.debian.org
Mon Feb 16 14:58:34 UTC 2015


This is an automated email from the git hooks/post-receive script.

reazem-guest pushed a commit to branch master
in repository jsemver.

commit 7a60afd0854cc162408ffa6216bd61a09f96b7fa
Author: Zafar Khaja <zafarkhaja at gmail.com>
Date:   Thu Aug 14 22:11:47 2014 +0300

    Add Exception Handling section to README
---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index 020f5c7..f4b1cf8 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,7 @@ development and its public API should not be considered stable.
   * [Incrementing Versions](#incrementing-versions)
   * [Comparing Versions](#comparing-versions)
 * [SemVer Expressions API (Ranges)](#semver-expressions-api-ranges)
+* [Exception Handling](#exception-handling)
 * [Bugs and Features](#bugs-and-features)
 * [License](#license)
 
@@ -254,6 +255,22 @@ other interesting capabilities of the SemVer Expressions DSL.
 * Parenthesized expression - `~1.3 | (1.4.* & !=1.4.5) | ~2`
 
 
+Exception Handling
+------------------
+There are two types of errors that may arrise while using Java SemVer
+* `IllegalArgumentException` is thrown when the passed value is `NULL` or empty
+  if a method accepts `string` argument or a negative integer if a method accepts
+  `int` arguments.
+* `ParseException` is thrown by methods that perform parsing of SemVer version
+  strings or SemVer Expressions. There are few subtypes of the `ParseException`
+  error
+  - `UnexpectedCharacterException` is thrown when a SemVer version string contains
+    an unexpected or illegal character
+  - `LexerException` is thrown when a SemVer Expression contains an illegal character
+  - `UnexpectedTokenException` is thrown when an unexpected token is encountered
+    during the SemVer Expression parsing
+
+
 Bugs and Features
 -----------------
 Bug reports and feature requests can be submitted at https://github.com/zafarkhaja/java-semver/issues.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/jsemver.git



More information about the pkg-java-commits mailing list