com.randomcoder.user
Class Role

java.lang.Object
  com.randomcoder.user.Role

All Implemented Interfaces:

Serializable, Comparable<Role>

public class Role
extends Object
implements Serializable, Comparable<Role>

JavaBean representing a security role.

 Copyright (c) 2006, Craig Condit. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
   * Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
     
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 

See Also:

Serialized Form

Field Summary

static Comparator<Role>	DESCRIPTION_COMPARATOR Role Comparator (by description).
static Comparator<Role>	NAME_COMPARATOR Role Comparator (by name).

Constructor Summary

Role()

Method Summary

int	compareTo(Role o) Compares this role to another role by description.
boolean	equals(Object obj) Determines if two Role objects are equal.
String	getDescription() Gets the description of this role.
Long	getId() Gets the id of this role.
String	getName() Gets the name of this role.
int	hashCode() Gets the hash code of this role.
void	setDescription(String description) Sets the description of this role.
void	setId(Long id) Sets the id of this role.
void	setName(String name) Sets the name of this role.
String	toString() Gets a string representation of this object, suitable for debugging.

Methods inherited from class java.lang.Object

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

Field Detail

NAME_COMPARATOR

public static final Comparator<Role> NAME_COMPARATOR

Role Comparator (by name).

DESCRIPTION_COMPARATOR

public static final Comparator<Role> DESCRIPTION_COMPARATOR

Role Comparator (by description).

Constructor Detail

Role

public Role()

Method Detail

getId

public Long getId()

Gets the id of this role.

Returns:

role id

setId

public void setId(Long id)

Sets the id of this role.

Parameters:

id - role id

getName

public String getName()

Gets the name of this role.

Returns:

role name

setName

public void setName(String name)

Sets the name of this role.

Parameters:

name - role name

getDescription

public String getDescription()

Gets the description of this role.

Returns:

role description, or null if not supplied.

setDescription

public void setDescription(String description)

Sets the description of this role.

Parameters:

description - role description

equals

public boolean equals(Object obj)

Determines if two Role objects are equal.

Overrides:

equals in class Object

Returns:

true if equal, false if not

hashCode

public int hashCode()

Gets the hash code of this role.

Overrides:

hashCode in class Object

Returns:

hash code

compareTo

public int compareTo(Role o)

Compares this role to another role by description.

Specified by:

compareTo in interface Comparable<Role>

Returns:

0 if equal, -1 if this is before, 1 if this is after

toString

public String toString()

Gets a string representation of this object, suitable for debugging.

Overrides:

toString in class Object

Returns:

string representation of this object