PGPainless/sop-java
1
0
Fork 0
mirror of https://codeberg.org/PGPainless/sop-java.git synced 2024-11-22 23:22:05 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add documentation to new exception types

Browse source
This commit is contained in:
Paul Schaub 2023-04-17 14:01:49 +02:00
parent 360f2fba02
commit 7e12da400b
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 35 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
sop-java/src/main/java/sop/exception/SOPGPException.java
View file

@ -379,6 +379,9 @@ public abstract class SOPGPException extends RuntimeException {
} }
} }
/**
* User provided incompatible options (e.g. "--as=clearsigned --no-armor").
*/
public static class IncompatibleOptions extends SOPGPException { public static class IncompatibleOptions extends SOPGPException {
public static final int EXIT_CODE = 83; public static final int EXIT_CODE = 83;
@ -397,6 +400,10 @@ public abstract class SOPGPException extends RuntimeException {
} }
} }
/**
* The user provided a subcommand with an unsupported profile ("--profile=XYZ"),
* or the user tried to list profiles of a subcommand that does not support profiles at all.
*/
public static class UnsupportedProfile extends SOPGPException { public static class UnsupportedProfile extends SOPGPException {
public static final int EXIT_CODE = 89; public static final int EXIT_CODE = 89;
@ -404,28 +411,56 @@ public abstract class SOPGPException extends RuntimeException {
private final String subcommand; private final String subcommand;
private final String profile; private final String profile;
/**
* Create an exception signalling a subcommand that does not support any profiles.
*
* @param subcommand subcommand
*/
public UnsupportedProfile(String subcommand) { public UnsupportedProfile(String subcommand) {
super("Subcommand '" + subcommand + "' does not support any profiles."); super("Subcommand '" + subcommand + "' does not support any profiles.");
this.subcommand = subcommand; this.subcommand = subcommand;
this.profile = null; this.profile = null;
} }
/**
* Create an exception signalling a subcommand does not support a specific profile.
*
* @param subcommand subcommand
* @param profile unsupported profile
*/
public UnsupportedProfile(String subcommand, String profile) { public UnsupportedProfile(String subcommand, String profile) {
super("Subcommand '" + subcommand + "' does not support profile '" + profile + "'."); super("Subcommand '" + subcommand + "' does not support profile '" + profile + "'.");
this.subcommand = subcommand; this.subcommand = subcommand;
this.profile = profile; this.profile = profile;
} }
/**
* Wrap an exception into another instance with a possibly translated error message.
*
* @param errorMsg error message
* @param e exception
*/
public UnsupportedProfile(String errorMsg, UnsupportedProfile e) { public UnsupportedProfile(String errorMsg, UnsupportedProfile e) {
super(errorMsg, e); super(errorMsg, e);
this.subcommand = e.getSubcommand(); this.subcommand = e.getSubcommand();
this.profile = e.getProfile(); this.profile = e.getProfile();
} }
/**
* Return the subcommand name.
*
* @return subcommand
*/
public String getSubcommand() { public String getSubcommand() {
return subcommand; return subcommand;
} }
/**
* Return the profile name.
* May return <pre>null</pre>.
*
* @return profile name
*/
public String getProfile() { public String getProfile() {
return profile; return profile;
} }