com.helger.as2lib.partner.xml

Class AbstractPartnershipFactoryWithPartners

java.lang.Object

com.helger.as2lib.AbstractDynamicComponent

com.helger.as2lib.partner.AbstractPartnershipFactory

com.helger.as2lib.partner.xml.AbstractPartnershipFactoryWithPartners

All Implemented Interfaces:

IDynamicComponent, IPartnershipFactory, IPartnershipFactoryWithPartners

Direct Known Subclasses:

XMLPartnershipFactory

@ThreadSafe
public abstract class AbstractPartnershipFactoryWithPartners
extends AbstractPartnershipFactory
implements IPartnershipFactoryWithPartners

Abstract IPartnershipFactoryWithPartners implementation based on AbstractPartnershipFactory using PartnerMap as the underlying data storage object for the partners.

Author:

Philip Helger

Field Summary

Fields inherited from class com.helger.as2lib.AbstractDynamicComponent

m_aRWLock

Constructor Summary

Constructors

Constructor and Description
AbstractPartnershipFactoryWithPartners()

Method Summary

Modifier and Type	Method and Description
void	addPartner(Partner aNewPartner) Add a partner.
boolean	equals(Object o)
com.helger.commons.collection.impl.ICommonsSet<String>	getAllPartnerNames()
com.helger.commons.collection.impl.ICommonsList<Partner>	getAllPartners()
IPartnerMap	getPartnerMap()
Partner	getPartnerOfName(String sPartnerName) Get all the partner data of the partner with the given name.
int	hashCode()
com.helger.commons.state.EChange	removePartner(String sPartnerName) Remove a partner.
protected void	setPartners(PartnerMap aPartners)

Methods inherited from class com.helger.as2lib.partner.AbstractPartnershipFactory

addPartnership, getAllPartnershipNames, getAllPartnerships, getPartnership, getPartnershipByName, getPartnershipMap, markAsChanged, removePartnership, setPartnerships, toString, updatePartnership, updatePartnership

Methods inherited from class com.helger.as2lib.AbstractDynamicComponent

attrs, getAttributeAsIntRequired, getAttributeAsStringRequired, getName, getSession, initDynamicComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.as2lib.partner.IPartnershipFactory

addPartnership, getAllPartnershipNames, getAllPartnerships, getPartnership, getPartnershipByName, removePartnership, updatePartnership, updatePartnership

Methods inherited from interface com.helger.as2lib.IDynamicComponent

attrs, getName, getSession, initDynamicComponent

Constructor Detail

AbstractPartnershipFactoryWithPartners

public AbstractPartnershipFactoryWithPartners()

Method Detail

setPartners

protected final void setPartners(@Nonnull
                                 PartnerMap aPartners)
                          throws AS2Exception

Throws:

AS2Exception

addPartner

public void addPartner(@Nonnull
                       Partner aNewPartner)
                throws AS2Exception

Description copied from interface: IPartnershipFactoryWithPartners

Add a partner.

Specified by:

addPartner in interface IPartnershipFactoryWithPartners

Parameters:

aNewPartner - The partner data to be used. May not be null.

Throws:

AS2Exception - Generic error

removePartner

@Nonnull
public com.helger.commons.state.EChange removePartner(@Nullable
                                                                String sPartnerName)
                                                         throws AS2Exception

Description copied from interface: IPartnershipFactoryWithPartners

Remove a partner.

Specified by:

removePartner in interface IPartnershipFactoryWithPartners

Parameters:

sPartnerName - The name of the partner to be removed.

Returns:

EChange.CHANGED if the partner was successfully removed, EChange.UNCHANGED if no such partner exists.

Throws:

AS2Exception - Generic error

getPartnerOfName

@Nullable
public Partner getPartnerOfName(@Nullable
                                           String sPartnerName)

Description copied from interface: IPartnershipFactoryWithPartners

Get all the partner data of the partner with the given name.

Specified by:

getPartnerOfName in interface IPartnershipFactoryWithPartners

Parameters:

sPartnerName - Partner name to search. May be null.

Returns:

null if no such partner exists.

getAllPartnerNames

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsSet<String> getAllPartnerNames()

Specified by:

getAllPartnerNames in interface IPartnershipFactoryWithPartners

Returns:

A set with all contained partner names. Never null but maybe empty.

getAllPartners

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<Partner> getAllPartners()

Specified by:

getAllPartners in interface IPartnershipFactoryWithPartners

Returns:

An (unordered) list of all contained partner data.

getPartnerMap

@Nonnull
public IPartnerMap getPartnerMap()

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractPartnershipFactory

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPartnershipFactory