com.helger.as2lib.partner

Class PartnershipMap

java.lang.Object

com.helger.as2lib.partner.PartnershipMap

All Implemented Interfaces:

IPartnershipMap

@NotThreadSafe
public final class PartnershipMap
extends Object
implements IPartnershipMap

The default implementation of IPartnershipMap.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
PartnershipMap()

Method Summary

Modifier and Type	Method and Description
com.helger.commons.state.EChange	addPartnership(Partnership aPartnership) Add a new partnership.
com.helger.commons.collection.impl.ICommonsOrderedSet<String>	getAllPartnershipNames()
com.helger.commons.collection.impl.ICommonsList<Partnership>	getAllPartnerships()
Partnership	getPartnershipByID(com.helger.commons.collection.attr.IStringMap aSenderIDs, com.helger.commons.collection.attr.IStringMap aReceiverIDs)
Partnership	getPartnershipByName(String sName)
com.helger.commons.state.EChange	removePartnership(Partnership aPartnership) Remove the provided partnership.
void	setPartnership(Partnership aPartnership) Overwrite an existing partnership.
void	setPartnerships(PartnershipMap aPartnerships) Set all partnerships from the passed map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PartnershipMap

public PartnershipMap()

Method Detail

setPartnerships

public void setPartnerships(@Nonnull
                            PartnershipMap aPartnerships)

Set all partnerships from the passed map. All existing partnerships are removed.

Parameters:

aPartnerships - The partnerships to be set. May not be null.

addPartnership

@Nonnull
public com.helger.commons.state.EChange addPartnership(@Nonnull
                                                                 Partnership aPartnership)

Add a new partnership.

Parameters:

aPartnership - The partnership to be added. May not be null.

Returns:

EChange.CHANGED if adding was successfully, EChange.UNCHANGED if a partnership with the given name is already present and nothing changed.

setPartnership

public void setPartnership(@Nonnull
                           Partnership aPartnership)

Overwrite an existing partnership.

Parameters:

aPartnership - The partnership to be set (and potentially overwritten). May not be null.

removePartnership

@Nonnull
public com.helger.commons.state.EChange removePartnership(@Nonnull
                                                                    Partnership aPartnership)

Remove the provided partnership.

Parameters:

aPartnership - The partnership to be removed. May not be null.

Returns:

EChange.CHANGED if removal was successful, EChange.UNCHANGED if no such partnership is contained.

getPartnershipByName

@Nullable
public Partnership getPartnershipByName(@Nullable
                                                   String sName)

Specified by:

getPartnershipByName in interface IPartnershipMap

getPartnershipByID

@Nullable
public Partnership getPartnershipByID(@Nonnull
                                                 com.helger.commons.collection.attr.IStringMap aSenderIDs,
                                                 @Nonnull
                                                 com.helger.commons.collection.attr.IStringMap aReceiverIDs)

Specified by:

getPartnershipByID in interface IPartnershipMap

getAllPartnershipNames

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsOrderedSet<String> getAllPartnershipNames()

Specified by:

getAllPartnershipNames in interface IPartnershipMap

getAllPartnerships

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<Partnership> getAllPartnerships()

Specified by:

getAllPartnerships in interface IPartnershipMap