io.sphere.sdk.types.FieldDefinition Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sphere-models Show documentation

sphere-models

There is a newer version: 1.0.0-M26

package io.sphere.sdk.types;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.sphere.sdk.models.Base;
import io.sphere.sdk.models.LocalizedString;
import io.sphere.sdk.models.TextInputHint;

public class FieldDefinition extends Base {
    private final FieldType type;
    private final String name;
    private final LocalizedString label;
    @JsonProperty("required")
    private final Boolean required;
    private final TextInputHint inputHint;

    @JsonCreator
    private FieldDefinition(final FieldType type, final String name, final LocalizedString label, final Boolean required, final TextInputHint inputHint) {
        this.type = type;
        this.name = name;
        this.label = label;
        this.required = required;
        this.inputHint = inputHint;
    }

    public static FieldDefinition of(final FieldType type, final String name, final LocalizedString label, final Boolean required, final TextInputHint inputHint) {
        return new FieldDefinition(type, name, label, required, inputHint);
    }

    public FieldType getType() {
        return type;
    }

    public String getName() {
        return name;
    }

    public LocalizedString getLabel() {
        return label;
    }

    @JsonProperty("required")
    public Boolean isRequired() {
        return required;
    }

    public TextInputHint getInputHint() {
        return inputHint;
    }
}