IServerImplMetadata (Perforce Java API 2015.1.1210280 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
`static class`	`IServerImplMetadata.ImplType` Describes the various known implementation types.

Method Summary
`String`	`getComments()` Return any comments associated with the implementation.
`String`	`getImplClassName()` Return the canonical name of the implementation class associated with this implementation.
`IServerImplMetadata.ImplType`	`getImplType()` Get the implementation type associated with this implementation.
`int`	`getMinimumServerLevel()` Get the earliest Perforce server version that this implementation will work reliably against.
`String`	`getScreenName()` Return a short name for this implementation, intended for use in menu pulldowns, etc.
`String`	`getUriScheme()` Get the URI scheme part to be used to specify this implementation to the server factory.
`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.

Method Detail

getScreenName

String getScreenName()

Return 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

String getImplClassName()

Return 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()

Get the implementation type associated with this implementation.

getUriScheme

String getUriScheme()

Get the URI scheme part to be used to specify this implementation to the server factory.

getMinimumServerLevel

int getMinimumServerLevel()

Get the earliest Perforce server version that this implementation will work reliably against. Typically in the form 20073 or 20091, etc.

getComments

String getComments()

Return 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.