Adapter pattern

related topics
{system, computer, user}
{math, number, function}
{law, state, case}

In computer programming, the adapter pattern (often referred to as the wrapper pattern or simply a wrapper) is a design pattern that translates one interface for a class into a compatible interface. An adapter allows classes to work together that normally could not because of incompatible interfaces, by providing its interface to clients while using the original interface. The adapter translates calls to its interface into calls to the original interface, and the amount of code necessary to do this is typically small. The adapter is also responsible for transforming data into appropriate forms. For instance, if multiple boolean values are stored as a single integer (i.e. flags) but your consumer requires a 'true'/'false', the adapter would be responsible for extracting the appropriate values from the integer value. Another example is transforming the format of dates (e.g. YYYYMMDD to MM/DD/YYYY or DD/MM/YYYY).

Contents

Structure

There are two types of adapter pattern:

Object Adapter pattern

In this type of adapter pattern, the adapter contains an instance of the class it wraps. In this situation, the adapter makes calls to the instance of the wrapped object.

Class Adapter pattern

This type of adapter uses multiple inheritance to achieve its goal. The adapter is created inheriting from both the interface that is expected and the interface that is pre-existing. It is typical for the expected interface to be created as a pure interface class, especially in languages such as Java that do not support multiple inheritance.

The adapter pattern is useful in situations where an already existing class provides some or all of the services you need but does not use the interface you need. A good real life example is an adapter that converts the interface of a Document Object Model of an XML document into a tree structure that can be displayed. A link to a tutorial that uses the adapter design pattern is listed in the links below.

A further form of runtime Adapter pattern

There is a further form of runtime Adapter pattern as follows:

It is desired for classA to supply classB with some data, let us suppose some String data. A compile time solution is:

classB.setStringData(classA.getStringData());

However, suppose that the format of the string data must be varied. A compile time solution is to use inheritance:

Format1ClassA extends ClassA {
 public String getStringData() {
  return format(toString());
 }
}

and perhaps create the correctly "formatting" object at runtime by means of the Factory pattern.

A solution using "adapters" proceeds as follows:

(i) define an intermediary "Provider" interface, and write an implementation of that Provider interface which wraps the source of the data, ClassA in this example, and outputs the data formatted as appropriate:

public interface StringProvider {
    public String getStringData();
}
 
public class ClassAFormat1 implements StringProvider {
    ClassA classA;
 
    public ClassAFormat1(ClassA classA) {
        this.classA = classA;
    }
 
    public String getStringData() {
        return format(classA.toString());
    }
}


(ii) Write an Adapter class which returns the specific implementation of the Provider:

public class ClassAFormat1Adapter extends Adapter {
 public Object adapt(Object o) {
  return new ClassAFormat1((ClassA) o);
 }
 
 public boolean isAdapterFor(Class c) {
 
  return c.equals(StringProvider.class);
 }
 
}


(iii) Register the Adapter with a global registry, so that the Adapter can be looked up at runtime:

AdapterFactory.getInstance().registerAdapter(ClassA.class, ClassAFormat1Adapter.class, "format1");

(iv) In your code, when you wish to transfer data from ClassA to ClassB, write:

Adapter adapter = AdapterFactory.getInstance().getAdapterFromTo(ClassA.class, StringProvider.class, "format1");
 
StringProvider provider = (StringProvider) adapter.adapt(classA);
 
String string = provider.getStringData();
 
classB.setStringData(string);


or more concisely:

classB.setStringData((StringProvider) AdapterFactory.getInstance().getAdapterFromTo(ClassA.class,
StringProvider.class, "format1").adapt(classA)).getStringData();

(v) The advantage can be seen in that, if it is desired to transfer the data in a second format, then look up the different adapter/provider:

Adapter adapter = AdapterFactory.getInstance().getAdapterFromTo(ClassA.class, StringProvider.class, "format2");

(vi) And if it is desired to output the data from ClassA as, say, image data in Class C:

Adapter adapter = AdapterFactory.getInstance().getAdapterFromTo(ClassA.class, ImageProvider.class, "format1");
 
ImageProvider provider = (ImageProvider) adapter.adapt(classA);
 
classC.setImage(provider.getImage());

(vii) In this way, the use of adapters and providers allows multiple "views" by ClassB and ClassC into ClassA without having to alter the class hierarchy. In general, it permits a mechanism for arbitrary data flows between objects which can be retrofitted to an existing object hierarchy.

Full article ▸

related documents
Maclisp
Triple DES
Portable Distributed Objects
Creator code
Synchronized Multimedia Integration Language
RenderMan Interface Specification
Run-length encoding
Time to live
Program counter
Z3 (computer)
Wikipedia:Free On-line Dictionary of Computing/I - K
BASIC09
Linker
Karplus-Strong string synthesis
CHS conversion
Command-line interpreter
Debugger
Monolithic kernel
Randomizer
386BSD
Information hiding
XPCOM
Bourne shell
Dictionary attack
Pseudonymous remailer
G.711
SAPHIRE
ScriptBasic
User space
AutoLISP