DataPointModality.java

/*
 * Copyright 2015 Open mHealth
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.openmhealth.schema.domain.omh;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

import javax.annotation.Nullable;
import java.util.HashMap;
import java.util.Map;


/**
 * The modality of a data point. The modality represents whether the data point was sensed by a device or
 * application, or whether it was reported by a person.
 *
 * @author Emerson Farrugia
 * @version 1.0
 * @see <a href="http://www.openmhealth.org/documentation/#/schema-docs/schema-library/schemas/omh_header">header</a>
 */
public enum DataPointModality implements SchemaEnumValue {

    SENSED,
    SELF_REPORTED;

    private String schemaValue;
    private static final Map<String, DataPointModality> constantsBySchemaValue = new HashMap<>();

    static {
        for (DataPointModality constant : values()) {
            constantsBySchemaValue.put(constant.getSchemaValue(), constant);
        }
    }

    DataPointModality() {
        this.schemaValue = name().toLowerCase().replace('_', '-');
    }

    @Override
    @JsonValue
    public String getSchemaValue() {
        return this.schemaValue;
    }

    @Nullable
    @JsonCreator
    public static DataPointModality findBySchemaValue(String schemaValue) {
        return constantsBySchemaValue.get(schemaValue);
    }
}