com.github.dockerunit.core.annotation

Interface ExtensionInterpreter<T extends Annotation>

Type Parameters:

T - the type variable indicating the annotation this class can interpret.

All Known Implementing Classes:

CommandExtensionInterpreter, EnvExtensionInterpreter, PublishPortExtensionInterpreter, PublishPortsExtensionInterpreter, RepeatablePublishPortExtensionInterpreter, VolumeExtensionInterpreter, VolumeWrapperExtensionInterpreter

public interface ExtensionInterpreter<T extends Annotation>

Definition of an annotation interpreter. Extending Dockerunit consists of: 1) Declaring an annotation 2) Marking it with @ExtensionMarker 3) Providing an interpreter for the created annotation that applies changes to the Docker container based on the annotation value.

 
  [at]ExtensionMarker(MyDnsAnnotationInterpreter.class)
 	public @interface MyDnsAnnotation {
 		String value() default "8.8.4.4";
  }

  public class MyDnsAnnotationInterpreter implements ExtensionInterpreter<MyDnsAnnotation> {

    [at]Override
    public CreateContainerCmd build(TestDescriptor td, CreateContainerCmd cmd, MyDnsAnnotation t) {
      return cmd.withDns(t.value());
    }
  }
 
 

Method Summary

Modifier and Type	Method and Description
com.github.dockerjava.api.command.CreateContainerCmd	build(ServiceDescriptor sd, com.github.dockerjava.api.command.CreateContainerCmd cmd, T t) Updates the CreateContainerCmd instance to reflect the value of the interpreted annotation.

Method Detail

build

com.github.dockerjava.api.command.CreateContainerCmd build(ServiceDescriptor sd,
                                                           com.github.dockerjava.api.command.CreateContainerCmd cmd,
                                                           T t)

Updates the CreateContainerCmd instance to reflect the value of the interpreted annotation.

Parameters:

sd - the whole configuration for this test including values from other annotations.

cmd - the docker-java command that will instantiate the Docker container based on Dockerunit config

t - the annotation that is interpreted by this class

Returns:

the updated CreateContainerCmd instance