Package com.perforce.p4java.server
Interface IServerImplMetadata
-
public interface IServerImplMetadata
Provides an interface onto information about Perforce server implementations available through the server factory. Useful for presenting choices to end users, debugging, etc.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IServerImplMetadata.ImplType
Describes the various known implementation types.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getComments()
java.lang.String
getImplClassName()
IServerImplMetadata.ImplType
getImplType()
int
getMinimumServerLevel()
java.lang.String
getScreenName()
java.lang.String
getUriScheme()
boolean
isDefault()
-
-
-
Method Detail
-
getScreenName
java.lang.String getScreenName()
- Returns:
- a short name for this implementation, intended for use in menu pulldowns, etc. May contain spaces, but won't usually be more than 32 characters long.
-
getImplClassName
java.lang.String getImplClassName()
- Returns:
- the canonical name of the implementation class associated with this implementation.
-
isDefault
boolean isDefault()
- Returns:
- true IFF this implementation will be used if the non-specific implementation scheme "p4j" is provided in the URI passed in to the server factory. There will be only one such default implementation for each factory.
-
getImplType
IServerImplMetadata.ImplType getImplType()
- Returns:
- the implementation type associated with this implementation.
-
getUriScheme
java.lang.String getUriScheme()
- Returns:
- the URI scheme part to be used to specify this implementation to the server factory.
-
getMinimumServerLevel
int getMinimumServerLevel()
- Returns:
- the earliest Perforce server version that this implementation will work reliably against. Typically in the form 20073 or 20091, etc.
-
getComments
java.lang.String getComments()
- Returns:
- any comments associated with the implementation. These should note any special restrictions or dependencies associated with the implementation that the user might need to know; this string may be null.
-
-