|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gdata.data.AbstractExtension
com.google.gdata.data.ExtensionPoint
com.google.gdata.data.BaseEntry<E>
com.google.gdata.data.media.MediaEntry<E>
com.google.gdata.data.photos.GphotoEntry<UserEntry>
com.google.gdata.data.photos.UserEntry
public class UserEntry
Entry for user kinds, contains user metadata.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.google.gdata.data.BaseEntry |
---|
BaseEntry.AtomHandler, BaseEntry.EntryState |
Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint |
---|
ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler |
Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension |
---|
AbstractExtension.AttributesHandler |
Field Summary | |
---|---|
static Category |
CATEGORY
User kind category. |
static java.lang.String |
KIND
User kind term value. |
Fields inherited from class com.google.gdata.data.BaseEntry |
---|
state |
Fields inherited from class com.google.gdata.data.ExtensionPoint |
---|
xmlBlob |
Fields inherited from class com.google.gdata.data.AbstractExtension |
---|
localName, namespace |
Fields inherited from interface com.google.gdata.data.photos.UserData |
---|
USER_CATEGORY, USER_KIND |
Constructor Summary | |
---|---|
UserEntry()
Default mutable constructor. |
|
UserEntry(BaseEntry<?> sourceEntry)
Constructs a new instance by doing a shallow copy of data from an existing BaseEntry instance. |
Method Summary | |
---|---|
void |
declareExtensions(ExtensionProfile extProfile)
Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. |
UserFeed |
getFeed(java.lang.String... kinds)
Retrieve the user feed and associated entries. |
java.lang.Integer |
getMaxPhotos()
The number of photos a user can have in a single album. |
GphotoMaxPhotos |
getMaxPhotosExt()
Returns the maximum number of photos allowed per album. |
java.lang.String |
getNickname()
The nickname of the user. |
GphotoNickname |
getNicknameExt()
Returns the display nickname of the user. |
java.lang.Long |
getQuotaLimit()
The quota limit of the user. |
GphotoQuotaLimit |
getQuotaLimitExt()
Returns the limit in bytes of the storage space for the user. |
java.lang.Long |
getQuotaUsed()
The quota in bytes that the user has used. |
GphotoQuotaUsed |
getQuotaUsedExt()
Returns the currently used quota of the user account. |
java.lang.String |
getThumbnail()
A url to the user's portrait. |
GphotoThumbnail |
getThumbnailExt()
Returns the user portrait thumbnail. |
java.lang.String |
getUsername()
The username of the user. |
GphotoUsername |
getUsernameExt()
Returns the username or currently selected persona. |
boolean |
hasMaxPhotosExt()
Returns whether it has the maximum number of photos allowed per album. |
boolean |
hasNicknameExt()
Returns whether it has the display nickname of the user. |
boolean |
hasQuotaLimitExt()
Returns whether it has the limit in bytes of the storage space for the user. |
boolean |
hasQuotaUsedExt()
Returns whether it has the currently used quota of the user account. |
boolean |
hasThumbnailExt()
Returns whether it has the user portrait thumbnail. |
boolean |
hasUsernameExt()
Returns whether it has the username or currently selected persona. |
void |
setMaxPhotos(java.lang.Integer max)
Set the maximum number of photos the user is allowed. |
void |
setMaxPhotosExt(GphotoMaxPhotos maxPhotosExt)
Sets the maximum number of photos allowed per album. |
void |
setNickname(java.lang.String nickname)
Set the nickname of the user this data represents. |
void |
setNicknameExt(GphotoNickname nicknameExt)
Sets the display nickname of the user. |
void |
setQuotaLimit(java.lang.Long quota)
Set the quota limit for the user this data represents. |
void |
setQuotaLimitExt(GphotoQuotaLimit quotaLimitExt)
Sets the limit in bytes of the storage space for the user. |
void |
setQuotaUsed(java.lang.Long quota)
Set the used quota for the user. |
void |
setQuotaUsedExt(GphotoQuotaUsed quotaUsedExt)
Sets the currently used quota of the user account. |
void |
setThumbnail(java.lang.String thumbnail)
Set the thumbnail for the user portrait. |
void |
setThumbnailExt(GphotoThumbnail thumbnailExt)
Sets the user portrait thumbnail. |
void |
setUsername(java.lang.String username)
Set the username for the user this data represents. |
void |
setUsernameExt(GphotoUsername usernameExt)
Sets the username or currently selected persona. |
java.lang.String |
toString()
|
protected void |
validate()
Checks the attributes to see if there are any problems. |
Methods inherited from class com.google.gdata.data.photos.GphotoEntry |
---|
generateRss, getAdaptedEntry, getDescription, getFeed, getFeedLink, getGphotoId, setDescription, setGphotoId, setGphotoId |
Methods inherited from class com.google.gdata.data.media.MediaEntry |
---|
getContentHandlerInfo, getMediaEditLink, getMediaSource, setMediaSource, setService, updateMedia |
Methods inherited from class com.google.gdata.data.BaseEntry |
---|
addAdaptor, addHtmlLink, addLink, addLink, delete, generate, generateAtom, getAdaptor, getAdaptors, getAuthors, getCanEdit, getCategories, getContent, getContributors, getEdited, getEditLink, getEtag, getHandler, getHtmlLink, getId, getKind, getLink, getLinks, getLinks, getPlainTextContent, getPubControl, getPublished, getResumableEditMediaLink, getRights, getSelectedFields, getSelf, getSelfLink, getService, getSource, getSummary, getTextContent, getTitle, getUpdated, getVersionId, isDraft, parseAtom, parseAtom, parseAtom, readEntry, readEntry, removeLinks, removeLinks, setCanEdit, setContent, setContent, setDraft, setEdited, setEtag, setId, setKind, setPubControl, setPublished, setRights, setSelectedFields, setSource, setSummary, setTitle, setUpdated, setVersionId, update, visitChildren |
Methods inherited from class com.google.gdata.data.AbstractExtension |
---|
consumeAttributes, disableStrictValidation, enableStrictValidation, eq, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, putAttributes, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.google.gdata.data.photos.AtomData |
---|
getAuthors, getCategories, getContributors, getDescription, getId, getLinks, getRights, getTitle, getUpdated, setDescription, setId, setRights, setTitle, setUpdated |
Methods inherited from interface com.google.gdata.data.photos.GphotoData |
---|
getGphotoId, setGphotoId, setGphotoId |
Methods inherited from interface com.google.gdata.data.photos.Extensible |
---|
addExtension, addRepeatingExtension, removeExtension, removeExtension, removeRepeatingExtension, setExtension |
Methods inherited from interface com.google.gdata.data.IEntry |
---|
getCanEdit, getContent, getEdited, getEditLink, getPublished, getResumableEditMediaLink, getSelectedFields, getSummary, setCanEdit, setEdited, setPublished, setSelectedFields |
Methods inherited from interface com.google.gdata.data.IAtom |
---|
addLink, getAuthors, getCategories, getEtag, getId, getKind, getLink, getLinks, getSelfLink, getTitle, getUpdated, getVersionId, removeLinks, removeLinks, setEtag, setId, setKind, setUpdated, setVersionId |
Field Detail |
---|
public static final java.lang.String KIND
public static final Category CATEGORY
Constructor Detail |
---|
public UserEntry()
public UserEntry(BaseEntry<?> sourceEntry)
BaseEntry
instance.
sourceEntry
- source entryMethod Detail |
---|
public void declareExtensions(ExtensionProfile extProfile)
ExtensionPoint
declareExtensions
in interface Kind.Adaptor
declareExtensions
in interface Extensible
declareExtensions
in class GphotoEntry<UserEntry>
extProfile
- the ExtensionProfile to initialize.ExtensionProfile.addDeclarations(Kind.Adaptor)
public GphotoMaxPhotos getMaxPhotosExt()
public void setMaxPhotosExt(GphotoMaxPhotos maxPhotosExt)
maxPhotosExt
- maximum number of photos allowed per album or
null
to resetpublic boolean hasMaxPhotosExt()
public GphotoNickname getNicknameExt()
public void setNicknameExt(GphotoNickname nicknameExt)
nicknameExt
- display nickname of the user or null
to
resetpublic boolean hasNicknameExt()
public GphotoQuotaLimit getQuotaLimitExt()
public void setQuotaLimitExt(GphotoQuotaLimit quotaLimitExt)
quotaLimitExt
- limit in bytes of the storage space for the user or
null
to resetpublic boolean hasQuotaLimitExt()
public GphotoQuotaUsed getQuotaUsedExt()
public void setQuotaUsedExt(GphotoQuotaUsed quotaUsedExt)
quotaUsedExt
- currently used quota of the user account or
null
to resetpublic boolean hasQuotaUsedExt()
public GphotoThumbnail getThumbnailExt()
public void setThumbnailExt(GphotoThumbnail thumbnailExt)
thumbnailExt
- user portrait thumbnail or null
to resetpublic boolean hasThumbnailExt()
public GphotoUsername getUsernameExt()
public void setUsernameExt(GphotoUsername usernameExt)
usernameExt
- username or currently selected persona or
null
to resetpublic boolean hasUsernameExt()
protected void validate()
AbstractExtension
validate
in class AbstractExtension
public java.lang.String toString()
toString
in class java.lang.Object
public UserFeed getFeed(java.lang.String... kinds) throws java.io.IOException, ServiceException
UserFeed userAndPhotos = userEntry.getFeed(PhotoData.KIND,
TagData.KIND);
If no kind parameters are passed, the default of
AlbumData.KIND
will be used.
kinds
- the kinds of entries to retrieve, or empty to use the default.
java.io.IOException
ServiceException
AlbumData.KIND
,
PhotoData.KIND
,
TagData.KIND
public java.lang.Integer getMaxPhotos()
UserData
getMaxPhotos
in interface UserData
public java.lang.String getNickname()
UserData
getNickname
in interface UserData
public java.lang.Long getQuotaLimit()
UserData
getQuotaLimit
in interface UserData
public java.lang.Long getQuotaUsed()
UserData
getQuotaUsed
in interface UserData
public java.lang.String getThumbnail()
UserData
getThumbnail
in interface UserData
public java.lang.String getUsername()
UserData
getUsername
in interface UserData
public void setMaxPhotos(java.lang.Integer max)
UserData
setMaxPhotos
in interface UserData
max
- the number of photos the user is allowed.public void setNickname(java.lang.String nickname)
UserData
setNickname
in interface UserData
nickname
- the nickname of the user.public void setQuotaLimit(java.lang.Long quota)
UserData
setQuotaLimit
in interface UserData
quota
- the quota in bytes for the user.public void setQuotaUsed(java.lang.Long quota)
UserData
setQuotaUsed
in interface UserData
quota
- the quota usage in bytes for this user.public void setThumbnail(java.lang.String thumbnail)
UserData
setThumbnail
in interface UserData
thumbnail
- the url to the user portrait image.public void setUsername(java.lang.String username)
UserData
setUsername
in interface UserData
username
- the username of the user.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |