com.google.api.server.spi.config.model

Class ApiKey

java.lang.Object

com.google.api.server.spi.config.model.ApiKey

public final class ApiKey
extends java.lang.Object

An immutable name which fully identifies an API.

Constructor Summary

Constructors

Constructor and Description
ApiKey(java.lang.String name, java.lang.String version)
ApiKey(java.lang.String name, java.lang.String version, java.lang.String root)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getApiString() Returns a string that uniquely identifies this API in the current context.
java.lang.String	getName()
java.lang.String	getRoot()
java.lang.String	getVersion()
int	hashCode()
java.lang.String	toString()
ApiKey	withoutRoot()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiKey

public ApiKey(java.lang.String name,
              java.lang.String version)

ApiKey

public ApiKey(java.lang.String name,
              java.lang.String version,
              @Nullable
              java.lang.String root)

Method Detail

getName

public java.lang.String getName()

getVersion

public java.lang.String getVersion()

getRoot

@Nullable
public java.lang.String getRoot()

getApiString

public java.lang.String getApiString()

Returns a string that uniquely identifies this API in the current context. Since any API running on App Engine is already implicitily under the same root, <name>-<version> should be able to uniquely identify an API.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

withoutRoot

public ApiKey withoutRoot()