Klasse ServletUsageFormatter
java.lang.Object
com.beust.jcommander.DefaultUsageFormatter
server.restful.common.parameter.usage.ServletUsageFormatter
- Alle implementierten Schnittstellen:
com.beust.jcommander.IUsageFormatter
public class ServletUsageFormatter
extends com.beust.jcommander.DefaultUsageFormatter
Change usage message to represent a servlet call usage. Servlet path is
treated like a main argument and servlet parameters as options.
- Autor:
- khaendel
-
Feldübersicht
Felder -
Konstruktorübersicht
KonstruktorenKonstruktorBeschreibungServletUsageFormatter(com.beust.jcommander.JCommander commander, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungvoidappendAllParametersDetails(StringBuilder out, int indentCount, String indent, List<com.beust.jcommander.ParameterDescription> sortedParameters) private voidappendCurrentRequestParameters(StringBuilder out, String indent) private voidprivate voidappendExampleUsage(StringBuilder out, int indentCount, String indent) voidappendMainLine(StringBuilder out, boolean hasOptions, boolean hasCommands, int indentCount, String indent) private voidappendServletPath(StringBuilder out, int indentCount, String indent) private StringcreateExampleUsage(String indent) private voidcreateRequestBodyExample(List<String> result, ContentTypeAndFileExtensions ct, Object requestBodyExample) private voidcreateResponseBodyExample(List<String> result, ContentTypeAndFileExtensions ct, Object responseBodyExample) private ResourceBundleprivate Stringprivate StringgetParameterName(String name) private StringgetServletParameterNames(String names) private static StringnewLineAndIndent(int indent) Returns new line followed by indent-many spaces.voidsetException(Exception exception) Von Klasse geerbte Methoden com.beust.jcommander.DefaultUsageFormatter
appendCommands, getCommandDescription, getI18nString, s, usage, usage, usage, usage, usage, wrapDescription, wrapDescription
-
Felddetails
-
LOG
-
commander
private com.beust.jcommander.JCommander commander -
request
private jakarta.servlet.http.HttpServletRequest request -
response
private jakarta.servlet.http.HttpServletResponse response -
exception
-
bundle
-
-
Konstruktordetails
-
ServletUsageFormatter
public ServletUsageFormatter(com.beust.jcommander.JCommander commander, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
-
-
Methodendetails
-
setException
-
getException
-
appendMainLine
public void appendMainLine(StringBuilder out, boolean hasOptions, boolean hasCommands, int indentCount, String indent) - Setzt außer Kraft:
appendMainLinein Klassecom.beust.jcommander.DefaultUsageFormatter
-
appendAllParametersDetails
public void appendAllParametersDetails(StringBuilder out, int indentCount, String indent, List<com.beust.jcommander.ParameterDescription> sortedParameters) - Setzt außer Kraft:
appendAllParametersDetailsin Klassecom.beust.jcommander.DefaultUsageFormatter
-
appendCurrentRequestParameters
-
appendErrorMessage
-
appendServletPath
-
appendExampleUsage
private void appendExampleUsage(StringBuilder out, int indentCount, String indent) throws MalformedURLException, URISyntaxException - Löst aus:
MalformedURLExceptionURISyntaxException
-
createRequestResponseBodyExamples
-
createRequestBodyExample
private void createRequestBodyExample(List<String> result, ContentTypeAndFileExtensions ct, Object requestBodyExample) -
createResponseBodyExample
private void createResponseBodyExample(List<String> result, ContentTypeAndFileExtensions ct, Object responseBodyExample) -
createExampleUsage
- Löst aus:
MalformedURLExceptionURISyntaxException
-
getExampleServletParameterName
-
getBundle
-
getServletParameterNames
-
getParameterName
-
newLineAndIndent
Returns new line followed by indent-many spaces.- Gibt zurück:
- new line followed by indent-many spaces
-