org.eclipse.microprofile.config.inject

Annotation Type ConfigProperties

@Target(value={METHOD,FIELD,PARAMETER,TYPE})
 @Retention(value=RUNTIME)
 @Documented
 @Qualifier
public @interface ConfigProperties

Retrieve a number of related configuration properties with the specified prefix into a property class. This class should contain a zero-arg constructor. Otherwise, non-portable behaviour occurs.

 @ConfigProperties(prefix="server")
 public class MyServer {
      public String host; //maps the property name server.host
      public int port;    //maps to the property name server.port
      private String context; //maps to the property name server.context
      public @ConfigProperty(name="old.location")
      String location; //maps to the property name server.old.location
      public String getContext() {
          return context;
      }
 }
 

Since:

2.0

Author:

Emily Jiang

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	prefix The prefix of the configuration properties

Element Detail

prefix

public abstract String prefix

The prefix of the configuration properties

Returns:

the configuration property prefix

Default:

""