java/com/fairphone/common/components/Calibrator.java

/*
 * Copyright 2019 Fairphone B.V.
 *
 * 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 com.fairphone.common.components;

/**
 * Interface used for calibrating modules and components.
 */
interface Calibrator {

    /**
     * Start the calibration process.
     */
    public Calibrator startCalibration();

    /**
     * Complete the calibration process.
     *
     * @returns {@code true} if the component successfully calibrated, otherwise {@code false}.
     */
    public boolean calibrate();
}