public static final class KeyFactory.Builder
extends java.lang.Object
Keys
with
ancestors. Initialize the Builder
with the topmost ancestor
in your key path and then add children using the addChild(java.lang.String, java.lang.String)
overload that best suits your needs. When finished adding children,
call getKey()
to retrieve your Key
or
getString()
to retrieve your Key
encoded as a websafe
String
.
Examples:import com.google.appengine.api.datastore.KeyFactory.Builder; ... Key key = new Builder("Person", 88).addChild("Address", 24).getKey(); String keyStr = new Builder("Photo Album", "Vacation").addChild("Photo", 1424).getString();
Constructor and Description |
---|
Builder(Key key)
Create a
Builder , establishing the provided Key as the
topmost ancestor. |
Builder(java.lang.String kind,
long id)
Create a
Builder , establishing a Key constructed from
the provided kind and id as the topmost ancestor. |
Builder(java.lang.String kind,
java.lang.String name)
Create a
Builder , establishing a Key constructed from
the provided kind and name as the topmost ancestor. |
Modifier and Type | Method and Description |
---|---|
KeyFactory.Builder |
addChild(java.lang.String kind,
long id)
|
KeyFactory.Builder |
addChild(java.lang.String kind,
java.lang.String name)
|
Key |
getKey() |
java.lang.String |
getString() |
public Builder(java.lang.String kind, java.lang.String name)
Builder
, establishing a Key
constructed from
the provided kind and name as the topmost ancestor.kind
- the kind of the topmost ancestorname
- the name of the topmost ancestor in kind
, as an
arbitrary string unique across root entities of this kind
public Builder(java.lang.String kind, long id)
Builder
, establishing a Key
constructed from
the provided kind and id as the topmost ancestor.kind
- the kind of the topmost ancestorid
- the numeric identifier of the topmost ancestor in kind
,
unique across root entities of this kind, must not be zeropublic KeyFactory.Builder addChild(java.lang.String kind, java.lang.String name)
Key
constructed from the provided kind and name
as the child of the Key
most recently added to the
Builder
.kind
- the kind of the childname
- the name of the child in kind
, as an arbitrary string
unique across entities of this kind
with the same parentthis
public KeyFactory.Builder addChild(java.lang.String kind, long id)
Key
constructed from the provided kind and id
as the child of the Key
most recently added to the
Builder
.kind
- the kind of the childid
- the numeric identifier of the child in kind
,
unique across entities of this kind with the same parent, must not be
zerothis
public java.lang.String getString()
Key
, encoded as a websafe
String
.