io.appium.java_client.imagecomparison.SimilarityMatchingResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation

Java client for Appium Mobile Webdriver

There is a newer version: 9.3.0

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * 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 io.appium.java_client.imagecomparison;

import java.util.Map;

public class SimilarityMatchingResult extends ComparisonResult {
    private static final String SCORE = "score";

    public SimilarityMatchingResult(Map input) {
        super(input);
    }

    /**
     * Returns the similarity score as a float number in range [0.0, 1.0].
     *
     * @return The similarity score as a float number in range [0.0, 1.0].
     *     1.0 is the highest score (means both images are totally equal).
     */
    public double getScore() {
        verifyPropertyPresence(SCORE);
        //noinspection unchecked
        if (getCommandResult().get(SCORE) instanceof Long) {
            return ((Long) getCommandResult().get(SCORE)).doubleValue();
        }
        return (double) getCommandResult().get(SCORE);
    }
}