Class EdgeConfig.Factory.Property

  • Enclosing class:
    EdgeConfig.Factory

    public static class EdgeConfig.Factory.Property
    extends java.lang.Object
    Represents a configuration option of an OpenEMS Component Factory.
    • Constructor Detail

      • Property

        public Property​(java.lang.String id,
                        java.lang.String name,
                        java.lang.String description,
                        OpenemsType type,
                        boolean isRequired,
                        boolean isPassword,
                        com.google.gson.JsonElement defaultValue,
                        com.google.gson.JsonObject schema)
    • Method Detail

      • toJson

        public com.google.gson.JsonObject toJson()
        Returns the Factory Property as a JSON Object.
         {
           id: string,
           name: string,
           description: string,
           isOptional: boolean,
           isPassword: boolean,
           defaultValue: any,
           schema: {
             type: string
           }
         }
         
        Returns:
        property as a JSON Object
      • getDescription

        public java.lang.String getDescription()
        Gets the Description of the EdgeConfig.Factory.Property.
        Returns:
        the Description
      • isPassword

        public boolean isPassword()
        Does this Property represent a password?.
        Returns:
        true if it is a password
      • isRequired

        public boolean isRequired()
        Is this Property required?.
        Returns:
        true if it is required
      • getDefaultValue

        public com.google.gson.JsonElement getDefaultValue()
        Gets the default value of the Property.
        Returns:
        the default value