org.apache.james.mime4j.field.address
Class AddressFormatter

java.lang.Object
  extended by org.apache.james.mime4j.field.address.AddressFormatter

public class AddressFormatter
extends java.lang.Object

Default formatter for Address and its subclasses.


Field Summary
static AddressFormatter DEFAULT
           
 
Constructor Summary
protected AddressFormatter()
           
 
Method Summary
 java.lang.String encode(Group group)
           
 java.lang.String encode(Mailbox mailbox)
           
 void encode(java.lang.StringBuilder sb, Address address)
          Returns a string representation of this address that can be used for transport purposes.
 void encode(java.lang.StringBuilder sb, Group group)
           
 void encode(java.lang.StringBuilder sb, Mailbox mailbox)
           
 java.lang.String format(Group group, boolean includeRoute)
           
 java.lang.String format(Mailbox mailbox, boolean includeRoute)
           
 void format(java.lang.StringBuilder sb, Address address, boolean includeRoute)
          Formats the address as a human readable string, not including the route.
 void format(java.lang.StringBuilder sb, Group group, boolean includeRoute)
           
 void format(java.lang.StringBuilder sb, Mailbox mailbox, boolean includeRoute)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT

public static final AddressFormatter DEFAULT
Constructor Detail

AddressFormatter

protected AddressFormatter()
Method Detail

format

public void format(java.lang.StringBuilder sb,
                   Address address,
                   boolean includeRoute)
Formats the address as a human readable string, not including the route. The resulting string is intended for display purposes only and cannot be used for transport purposes. For example, if the unparsed address was <"Joe Cheng"@joecheng.com> this method would return which is not valid for transport; the local part would need to be re-quoted.

Parameters:
includeRoute - true if the route should be included if it exists, false otherwise.

encode

public void encode(java.lang.StringBuilder sb,
                   Address address)
Returns a string representation of this address that can be used for transport purposes. The route is never included in this representation because routes are obsolete and RFC 5322 states that obsolete syntactic forms MUST NOT be generated.


format

public void format(java.lang.StringBuilder sb,
                   Mailbox mailbox,
                   boolean includeRoute)

format

public java.lang.String format(Mailbox mailbox,
                               boolean includeRoute)

encode

public void encode(java.lang.StringBuilder sb,
                   Mailbox mailbox)

encode

public java.lang.String encode(Mailbox mailbox)

format

public void format(java.lang.StringBuilder sb,
                   Group group,
                   boolean includeRoute)

format

public java.lang.String format(Group group,
                               boolean includeRoute)

encode

public void encode(java.lang.StringBuilder sb,
                   Group group)

encode

public java.lang.String encode(Group group)


Copyright © 2004-2012 The Apache Software Foundation. All Rights Reserved.