LimeWire Consolidated API

org.limewire.net.address
Interface AddressFactory

All Known Implementing Classes:
AddressFactoryImpl

public interface AddressFactory

A collection of AddressSerializers. Addresss should register themselves with this factory via the addSerializer() method at injection time.


Method Summary
 Address deserialize(String address)
          turns a user-input String into an Address
 Address deserialize(String type, byte[] serializedAddress)
          Deserialize an address, typically as read from a network message
 AddressSerializer getSerializer(Class<? extends Address> addressClass)
           
 AddressSerializer getSerializer(String addressType)
          Looks up serializer by AddressSerializer.getAddressType().
 void registerSerializer(AddressSerializer serializer)
          Registers an AddressSerializer with this AddressFactory.
 

Method Detail

registerSerializer

void registerSerializer(AddressSerializer serializer)
Registers an AddressSerializer with this AddressFactory.

Parameters:
serializer -

getSerializer

AddressSerializer getSerializer(Class<? extends Address> addressClass)
                                throws IllegalArgumentException
Parameters:
addressClass - cannot be null
Returns:
the AddressSerializer for a particular class
Throws:
IllegalArgumentException - if an AddressSerializer does not exist for the specified class

getSerializer

AddressSerializer getSerializer(String addressType)
Looks up serializer by AddressSerializer.getAddressType().

Returns:
null if no serializer is registered for that type

deserialize

Address deserialize(String type,
                    byte[] serializedAddress)
                    throws IOException
Deserialize an address, typically as read from a network message

Parameters:
type - the type of message contained in the byte array. Will match AddressSerializer.getType() for the AddressSerialzer for the Address contained in the byte []
serializedAddress -
Returns:
a non-null Address
Throws:
IOException - if there is an error deserializing the Address

deserialize

Address deserialize(String address)
                    throws IOException
turns a user-input String into an Address

Parameters:
address -
Returns:
an address representing the String parameter; never null
Throws:
IOException - if the input cannot be converted into an Address

LimeWire Consolidated API

Copyright © 2009. All Rights Reserved.