File	Doc	Category	Size	Date	Package
GDataAccount.java	API Doc	Apache Lucene 2.1.0	9550	Wed Feb 14 10:46:06 GMT 2007	org.apache.lucene.gdata.data

GDataAccount

• java.lang.Object

Fields Summary
private String	name
private String	authorname
private String	authorMail
private URL	authorLink
private String	password
private Set	roles

Constructors Summary
public GDataAccount() Creates a new GDataAccount. The default role {@link AccountRole#USER} will be set. this.roles.add(AccountRole.USER);

Methods Summary
public static final org.apache.lucene.gdata.data.GDataAccount	createAdminAccount() return - a new Administrator account GDataAccount retVal = new GDataAccount(); retVal.setName("administrator"); retVal.setPassword("password"); retVal.setRole(AccountRole.USERADMINISTRATOR); retVal.setRole(AccountRole.FEEDAMINISTRATOR); retVal.setRole(AccountRole.ENTRYAMINISTRATOR); return retVal;
public boolean	equals(java.lang.Object o) see java.lang.Object#equals(java.lang.Object) if(this.name == null) return super.equals(o); if(o == null) return false; if (this == o) return true; if (!(o instanceof GDataAccount)) return false; GDataAccount toCompare = (GDataAccount) o; if (this.name.equals(toCompare.name)) return true; return false;
public java.net.URL	getAuthorLink() return - the http link specified for the author return this.authorLink;
public java.lang.String	getAuthorMail() return - the authors mail address return this.authorMail;
public java.lang.String	getAuthorname() return - the name specified as being the author name return this.authorname;
public java.lang.String	getName() return - the account name return this.name;
public java.lang.String	getPassword() return - the password return this.password;
public java.util.Set	getRoles() return - the set containing all roles return this.roles;
public int	getRolesAsInt() see GDataAccount#setRolesAsInt(int) return - the integer representation for the user roles // 1 as the Userrole is always set int bits = 1; for (AccountRole role : this.roles) { if (role == AccountRole.ENTRYAMINISTRATOR) bits ^= 2; else if (role == AccountRole.FEEDAMINISTRATOR) bits ^= 4; else if (role == AccountRole.USERADMINISTRATOR) bits ^= 8; } return bits;
public int	hashCode() see java.lang.Object#hashCode() if(this.name == null) return super.hashCode(); int ret = 37; ret = 9 * ret + this.name.hashCode(); return ret;
public static boolean	isInRole(int intRole, org.apache.lucene.gdata.data.GDataAccount$AccountRole role) checks whether the given integer matches the account role. param intRole - integer representation of a role param role - the account role to match return true if and only if the given roles match, otherwise false if(role == AccountRole.USER) return (intRole&1)>0; if (role == AccountRole.ENTRYAMINISTRATOR) return (intRole&2) >0 ; else if (role == AccountRole.FEEDAMINISTRATOR) return (intRole&4) >0 ; else if (role == AccountRole.USERADMINISTRATOR) return (intRole&8) >0 ; return false;
public boolean	isUserInRole(org.apache.lucene.gdata.data.GDataAccount$AccountRole role) param role - the role to check return true if the role list contains the given role if (role == null) return false; return this.roles.contains(role);
public boolean	requiredValuesSet() Checks the requiered values for creating an account are set. Required values are name and password the minimum length of these values is 6. return true if an only if password and name are not null and the length is > 5 return (this.name != null && this.password != null && this.name.length() > 5 && this.password.length() > 5);
public void	setAuthorLink(java.net.URL authorLink) param authorLink - the http link specified for the author this.authorLink = authorLink;
public void	setAuthorMail(java.lang.String authorMail) param authorMail - the authors mail address this.authorMail = authorMail;
public void	setAuthorname(java.lang.String authorname) param authorname - the name specified as being the author name this.authorname = authorname;
public void	setName(java.lang.String name) param name The name to set. this.name = name;
public void	setPassword(java.lang.String password) param password - the account Password this.password = password;
public void	setRole(org.apache.lucene.gdata.data.GDataAccount$AccountRole role) Adds the given role to the role list param role - the role to add to the role list if (role == null) return; this.roles.add(role);
public void	setRolesAsInt(int i) Sets the roles from a int representation. The fist bit set indicates a {@link AccountRole#USER} - int value 1 The second bit set indicates a {@link AccountRole#ENTRYAMINISTRATOR} - int value 2 The third bit set indicates a {@link AccountRole#FEEDAMINISTRATOR} - int value 4 The forth bit set indicates a {@link AccountRole#USERADMINISTRATOR} - int value 8 This method will only set roles, will not remove roles! A combination of roles is also possible e.g. the int value 6 combines {@link AccountRole#ENTRYAMINISTRATOR} and {@link AccountRole#FEEDAMINISTRATOR}. param i - the integer used to set the roles if ((i & 2) > 0) this.roles.add(AccountRole.ENTRYAMINISTRATOR); if ((i & 4) > 0) this.roles.add(AccountRole.FEEDAMINISTRATOR); if ((i & 8) > 0) this.roles.add(AccountRole.USERADMINISTRATOR);
public java.lang.String	toString() see java.lang.Object#toString() StringBuilder builder = new StringBuilder("GdataAccount: "); builder.append("name: ").append(this.name); builder.append(" password: ").append((this.password!= null?" length: "+this.password.length():null)); builder.append(" author: ").append(this.authorname); builder.append(" author email: ").append(this.authorMail); builder.append(" author link: ").append(this.authorLink!=null?"":this.authorLink); return builder.toString();