gwt.material.design.client.api.ApiFeature Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * GwtMaterial
 * %%
 * Copyright (C) 2015 - 2018 GwtMaterialDesign
 * %%
 * 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.
 * #L%
 */
package gwt.material.design.client.api;

import com.google.gwt.core.client.Callback;
import gwt.material.design.client.api.google.maps.GoogleApi;

/**
 * A Base feature that can be extended to build your own custom API Component.
 * See {@link ApiRegistry#register(ApiFeature, Callback)}
 * @author kevzlou7979
 */
public interface ApiFeature {

    /**
     * Will construct the given url. See {@link GoogleApi#constructApiUrl()} for the usage.
     */
    String constructApiUrl();

    /**
     * A Feature Api Key {i.e Google API Key}
     */
    String getApiKey();

    /**
     * A Feature Api Url provided to load any external js framework {i.e Google Maps Js resources}
     */
    String getApiUrl();
}