public class ClientMessage
extends java.lang.Object
These are messages that the P4Java API itself generates rather than receives from the Perforce server. Most of these are copied fairly closely from the corresponding C++ API class(es) and not all are currently used. The messages defined here all use the common %arg% string interpolation scheme that's used for messages coming in from the server in (e.g.) client-Message packets.
The errors here are not typically passed as-is back to the end user, but are translated in the map-based server implementation superclass ServerImpl to more generic P4Java exceptions or filespec statuses.
No attempt has (yet) been made to internationalise the corresponding error strings, but that may happen in future releases of the API.
FIXME: what to do about P4Java-specific codes? -- HR.(Current strategy is to simply use zero, as we don't actually extract error codes anywhere yet).
Modifier and Type | Class and Description |
---|---|
static class |
ClientMessage.ClientMessageId
Basic message ID.
|
static class |
ClientMessage.ClientMessageType
Where the message originated, or which part
of the command chain it refers to.
|
Modifier and Type | Method and Description |
---|---|
static ClientMessage |
getClientMessage(ClientMessage.ClientMessageId id)
Return the ClientMessage associated with this ID, if any.
|
int |
getCode() |
ClientMessage.ClientMessageId |
getId() |
java.lang.String[] |
getMsgParamNames() |
java.lang.String[] |
getMsgs() |
void |
setCode(int code) |
void |
setId(ClientMessage.ClientMessageId id) |
void |
setMsgParamNames(java.lang.String[] msgParamNames) |
void |
setMsgs(java.lang.String[] msgs) |
public static ClientMessage getClientMessage(ClientMessage.ClientMessageId id)
id
- ClientMessageIdpublic ClientMessage.ClientMessageId getId()
public void setId(ClientMessage.ClientMessageId id)
public java.lang.String[] getMsgs()
public void setMsgs(java.lang.String[] msgs)
public java.lang.String[] getMsgParamNames()
public void setMsgParamNames(java.lang.String[] msgParamNames)
public int getCode()
public void setCode(int code)