org.jhotdraw8.application.resources.ResourceDecoder Maven / Gradle / Ivy

Go to download
/*
 * @(#)ResourceDecoder.java
 * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
 */
package org.jhotdraw8.application.resources;

import org.jhotdraw8.annotation.NonNull;

/**
 * Decodes a resource value.
 *
 * @author Werner Randelshofer
 */
public interface ResourceDecoder {

    /**
     * Returns true if this resource handler can decode the specified property
     * value.
     *
     * @param key           The property key
     * @param propertyValue the property value
     * @param type          The desired type
     * @return true if the property can be decoded
     */
    boolean canDecodeValue(String key, String propertyValue, Class type);

    /**
     * Decodes the property value.
     *
     * @param key           The property key
     * @param propertyValue The property value
     * @param type          The desired type
     * @param baseClass     The base class to be used if the property value is a
     *                      resource uri
     * @param            The type of the decoded object
     * @return the decoded object
     */
    @NonNull  T decode(String key, String propertyValue, Class type, Class baseClass);
}