Field Detail

• OK

  public static final int OK

  The reply code indicating success of an operation.

  See Also:

  Constant Field Values

• NO

  public static final int NO

  The reply code indicating failure of an operation.

  See Also:

  Constant Field Values

• BAD

  public static final int BAD

  The reply code indicating command rejection.

  See Also:

  Constant Field Values

• CONT

  public static final int CONT

  The reply code indicating command continuation.

  See Also:

  Constant Field Values

• PARTIAL

  public static final int PARTIAL

  The reply code indicating a partial response. This is used when a chunk listener is registered and the listener requests that the reply lines are cleared on return.

  Since:

  3.4

  See Also:

  Constant Field Values

Method Detail

• isUntagged

  public static boolean isUntagged(String line)

  Checks if the reply line is untagged - e.g. "* OK ..."

  Parameters:

  line - to be checked

  Returns:

  true if the line is untagged

• isContinuation

  public static boolean isContinuation(String line)

  Checks if the reply line is a continuation, i.e. starts with "+"

  Parameters:

  line - the line to be checked

  Returns:

  true if the line is untagged

• getReplyCode

  public static int getReplyCode(String line)
                          throws IOException

  Intepret the String reply code - OK, NO, BAD - in a tagged response as a integer.

  Parameters:

  line - the tagged line to be checked

  Returns:

  OK or NO or BAD or CONT

  Throws:

  IOException - if the input has an unexpected format

• literalCount

  public static int literalCount(String line)

  Checks if the line introduces a literal, i.e. ends with {dd}

  Parameters:

  line - the line to check

  Returns:

  the literal count, or -1 if there was no literal.

• getUntaggedReplyCode

  public static int getUntaggedReplyCode(String line)
                                  throws IOException

  Intepret the String reply code - OK, NO, BAD - in an untagged response as a integer.

  Parameters:

  line - the untagged line to be checked

  Returns:

  OK or NO or BAD or CONT

  Throws:

  IOException - if the input has an unexpected format

• isSuccess

  public static boolean isSuccess(int replyCode)

  Checks whether the reply code indicates success or not

  Parameters:

  replyCode - the code to check

  Returns:

  true if the code equals OK

• isContinuation

  public static boolean isContinuation(int replyCode)

  Checks if the reply line is a continuation, i.e. starts with "+"

  Parameters:

  replyCode - the code to be checked

  Returns:

  true if the response was a continuation