org.apache.james.mailbox.jpa.user.model

Class JPASubscription

java.lang.Object

org.apache.james.mailbox.jpa.user.model.JPASubscription

All Implemented Interfaces:

Subscription

@Entity(name="Subscription")
public class JPASubscription
extends Object
implements Subscription

A subscription to a mailbox by a user.

Constructor Summary

Constructors

Constructor and Description
JPASubscription() Deprecated.
JPASubscription(String username, String mailbox) Constructs a user subscription.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getMailbox() Gets the name of the mailbox to which the user is subscribed.
String	getUser() Gets the name of the subscribed user.
int	hashCode()
String	toString() Renders output suitable for debugging.

Methods inherited from class java.lang.Object

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

Constructor Detail

JPASubscription

@Deprecated
public JPASubscription()

Deprecated.

Used by JPA

JPASubscription

public JPASubscription(String username,
               String mailbox)

Constructs a user subscription.

Parameters:

username - not null

mailbox - not null

Method Detail

getMailbox

public String getMailbox()

Description copied from interface: Subscription

Gets the name of the mailbox to which the user is subscribed. Note that subscriptions must be maintained beyond the lifetime of a particular instance of a mailbox.

Specified by:

getMailbox in interface Subscription

Returns:

not null

See Also:

Subscription.getMailbox()

getUser

public String getUser()

Description copied from interface: Subscription

Gets the name of the subscribed user.

Specified by:

getUser in interface Subscription

Returns:

not null

See Also:

Subscription.getUser()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Renders output suitable for debugging.

Overrides:

toString in class Object

Returns:

output suitable for debugging