com.helger.photon.basic.object.client

Class AbstractHasClient

java.lang.Object

com.helger.photon.basic.object.client.AbstractHasClient

All Implemented Interfaces:

IHasClient, IHasClientID

Direct Known Subclasses:

AbstractHasAccountingAreaObject, AbstractHasAccountingAreaOptionalObject

@Immutable
public abstract class AbstractHasClient
extends Object
implements IHasClient

Constructor Summary

Constructors

Constructor and Description
AbstractHasClient(IClient aClient)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
IClient	getClient()
String	getClientID()
int	hashCode()
boolean	hasSameClient(IClient aClient) Check if the passed client has the same ID as this object
boolean	hasSameClientID(IClientObject aClientObject) Check if the passed object has the same client ID as this object
boolean	hasSameClientID(String sClientID) Check if the passed client ID has the same ID as this object
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHasClient

public AbstractHasClient(@Nonnull
                 IClient aClient)

Method Detail

getClientID

@Nonnull
@Nonempty
public final String getClientID()

Specified by:

getClientID in interface IHasClientID

Returns:

The client ID or null.

getClient

@Nonnull
public final IClient getClient()

Specified by:

getClient in interface IHasClient

Returns:

The client or null.

hasSameClientID

public final boolean hasSameClientID(@Nullable
                      String sClientID)

Description copied from interface: IHasClientID

Check if the passed client ID has the same ID as this object

Specified by:

hasSameClientID in interface IHasClientID

Parameters:

sClientID - The client ID to check. May be null.

Returns:

true if this object and the passed object have the same client ID

hasSameClientID

public final boolean hasSameClientID(@Nullable
                      IClientObject aClientObject)

Description copied from interface: IHasClient

Check if the passed object has the same client ID as this object

Specified by:

hasSameClientID in interface IHasClient

Parameters:

aClientObject - The object to check. May be null.

Returns:

true if this object and the passed object (if not null) have the same client ID

hasSameClient

public boolean hasSameClient(@Nullable
                    IClient aClient)

Description copied from interface: IHasClient

Check if the passed client has the same ID as this object

Specified by:

hasSameClient in interface IHasClient

Parameters:

aClient - The client ID to check. May be null.

Returns:

true if this object and the passed object have the same client ID

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object