StatusResponse.ResponseCode (Apache James Protocols 1.6.3-SNAPSHOT API)

java.lang.Object
- org.apache.james.imap.api.message.response.StatusResponse.ResponseCode

Enclosing interface:: StatusResponse

public static final class StatusResponse.ResponseCode
extends Object

Enumerates response codes.

Field Summary

Fields
Modifier and Type Field and Description

static int NO_NUMBER

Fields
Modifier and Type	Field and Description
`static int`	`NO_NUMBER`

Method Summary

Methods
Modifier and Type	Method and Description
`static StatusResponse.ResponseCode`	`alert()` Creates a RFC2060 `ALERT` response code.
`static StatusResponse.ResponseCode`	`appendUid(long uidValidity, IdRange[] uids)` RFC4315 `APPENDUID` response code
`static StatusResponse.ResponseCode`	`badCharset(Collection<String> charsetNames)` Creates a RFC2060 `BADCHARSET` response code.
`static StatusResponse.ResponseCode`	`closed()` Create a RFC5162 (QRESYNC) `CLOSED` response code
`static StatusResponse.ResponseCode`	`condStore(IdRange[] failedRanges)` RFC4551 `Conditional STORE` response code
`static StatusResponse.ResponseCode`	`copyUid(long uidValidity, IdRange[] sourceRanges, IdRange[] targetRanges)` RFC4315 `COPYUID` response code
`static StatusResponse.ResponseCode`	`createExtension(String name)` Creates an extension response code.
`boolean`	`equals(Object obj)`
`String`	`getCode()`
`long`	`getNumber()` Gets number for this response.
`Collection<String>`	`getParameters()` Gets parameters for this code.
`int`	`hashCode()`
`static StatusResponse.ResponseCode`	`highestModSeq(long modSeq)` Create a RFC4551 `HIGESTMODSEQ` response code
`static StatusResponse.ResponseCode`	`noModSeq()` Create a RFC4551 `NOMODSEQ` response code
`static StatusResponse.ResponseCode`	`parse()` Creates a RFC2060 `PARSE` response code.
`static StatusResponse.ResponseCode`	`permanentFlags(javax.mail.Flags flags)` Creates a RFC2060 `PERMENANTFLAGS` response code.
`static StatusResponse.ResponseCode`	`readOnly()` Creates a RFC2060 `READ-ONLY` response code.
`static StatusResponse.ResponseCode`	`readWrite()` Creates a RFC2060 `READ-WRITE` response code.
`String`	`toString()`
`static StatusResponse.ResponseCode`	`tryCreate()` Creates a RFC2060 `TRYCREATE` response code.
`static StatusResponse.ResponseCode`	`uidNext(long uid)` Creates a RFC2060 `UIDNEXT` response code.
`static StatusResponse.ResponseCode`	`uidValidity(long uid)` Creates a RFC2060 `UIDVALIDITY` response code.
`static StatusResponse.ResponseCode`	`unseen(int numberUnseen)` Creates a RFC2060 `UNSEEN` response code.
`boolean`	`useParens()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NO_NUMBER
```
public static final int NO_NUMBER
```
    See Also:
    Constant Field Values
- Method Detail
  - appendUid
```
public static StatusResponse.ResponseCode appendUid(long uidValidity,
                                    IdRange[] uids)
```
    RFC4315 APPENDUID response code
  - copyUid
```
public static StatusResponse.ResponseCode copyUid(long uidValidity,
                                  IdRange[] sourceRanges,
                                  IdRange[] targetRanges)
```
    RFC4315 COPYUID response code
  - condStore
```
public static StatusResponse.ResponseCode condStore(IdRange[] failedRanges)
```
    RFC4551 Conditional STORE response code
  - closed
```
public static StatusResponse.ResponseCode closed()
```
    Create a RFC5162 (QRESYNC) CLOSED response code
    
    Returns:
    code
  - alert
```
public static StatusResponse.ResponseCode alert()
```
    Creates a RFC2060 ALERT response code.
    
    Returns:
    ResponseCode, not null
  - badCharset
```
public static StatusResponse.ResponseCode badCharset(Collection<String> charsetNames)
```
    Creates a RFC2060 BADCHARSET response code.
    
    Parameters:
    charsetNames - Collection containing charset names
    
    Returns:
    ResponseCode, not null
  - parse
```
public static StatusResponse.ResponseCode parse()
```
    Creates a RFC2060 PARSE response code.
    
    Returns:
    ResponseCode, not null
  - permanentFlags
```
public static StatusResponse.ResponseCode permanentFlags(javax.mail.Flags flags)
```
    Creates a RFC2060 PERMENANTFLAGS response code.
    
    Parameters:
    flags - Collection containing flag names
    
    Returns:
    ResponseCode, not null
  - readOnly
```
public static StatusResponse.ResponseCode readOnly()
```
    Creates a RFC2060 READ-ONLY response code.
    
    Returns:
    ResponseCode, not null
  - readWrite
```
public static StatusResponse.ResponseCode readWrite()
```
    Creates a RFC2060 READ-WRITE response code.
    
    Returns:
    ResponseCode, not null
  - tryCreate
```
public static StatusResponse.ResponseCode tryCreate()
```
    Creates a RFC2060 TRYCREATE response code.
    
    Returns:
    ResponseCode, not null
  - uidValidity
```
public static StatusResponse.ResponseCode uidValidity(long uid)
```
    Creates a RFC2060 UIDVALIDITY response code.
    
    Parameters:
    uid - positive non-zero integer
    
    Returns:
    ResponseCode, not null
  - unseen
```
public static StatusResponse.ResponseCode unseen(int numberUnseen)
```
    Creates a RFC2060 UNSEEN response code.
    
    Parameters:
    numberUnseen - positive non-zero integer
    
    Returns:
    ResponseCode, not null
  - uidNext
```
public static StatusResponse.ResponseCode uidNext(long uid)
```
    Creates a RFC2060 UIDNEXT response code.
    
    Parameters:
    uid - positive non-zero integer
    
    Returns:
    ResponseCode, not null
  - highestModSeq
```
public static StatusResponse.ResponseCode highestModSeq(long modSeq)
```
    Create a RFC4551 HIGESTMODSEQ response code
    
    Parameters:
    modSeq - positive non-zero long
    
    Returns:
    ResponseCode
  - noModSeq
```
public static StatusResponse.ResponseCode noModSeq()
```
    Create a RFC4551 NOMODSEQ response code
    
    Returns:
    ResponseCode
  - createExtension
```
public static StatusResponse.ResponseCode createExtension(String name)
```
    Creates an extension response code. Names that do not begin with 'X' will have 'X' prepended
    
    Parameters:
    name - extension code, not null
    
    Returns:
    ResponseCode, not null
  - getCode
```
public String getCode()
```
  - getNumber
```
public long getNumber()
```
    Gets number for this response.
    
    Returns:
    the number, or zero if no number has been set
  - useParens
```
public boolean useParens()
```
  - getParameters
```
public Collection<String> getParameters()
```
    Gets parameters for this code.
    
    Returns:
    the parameters Collection of String parameters, not null
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class StatusResponse.ResponseCode

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_NUMBER

Method Detail

appendUid

copyUid

condStore

closed

alert

badCharset

parse

permanentFlags

readOnly

readWrite

tryCreate

uidValidity

unseen

uidNext

highestModSeq

noModSeq

createExtension

getCode

getNumber

useParens

getParameters

hashCode

equals

toString