com.applitools.utils.ReadOnlyPropertyHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eyes-common-java3 Show documentation

Common code for Applitools Eyes Java SDK projects

There is a newer version: 5.0.0

package com.applitools.utils;

import com.applitools.eyes.Logger;

/**
 * A property handler for read-only properties (i.e., set always fails).
 */
public class ReadOnlyPropertyHandler implements PropertyHandler {
    private final Logger logger;
    private final T obj;

    public ReadOnlyPropertyHandler(Logger logger, T obj) {
        this.logger = logger;
        this.obj = obj;
    }

    /**
     * This method does nothing. It simply returns false.
     * @param obj The object to set.
     * @return Always returns false.
     */
    public boolean set(T obj) {
        logger.verbose(String.format("Ignored. (%s)",
                getClass().getSimpleName()));
        return false;
    }

    /**
     * {@inheritDoc}
     */
    public T get() {
        return obj;
    }
}