org.onepf.opfpush.notification.NotificationPreparer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opfpush Show documentation

OPFPush library wrap push providers to comfort work on different android versions from different vendors

The newest version!

/*
 * Copyright 2012-2015 One Platform Foundation
 *
 * 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 org.onepf.opfpush.notification;

import android.os.Bundle;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import org.onepf.opfpush.model.NotificationPayload;

/**
 * The interface intended to define preparing an {@link NotificationPayload} instance from the {@code bundle}.
 *
 * @author Roman Savin
 * @since 23.06.2015
 */
public interface NotificationPreparer {

    /**
     * Converts the {@code bundle} to the {@code NotificationPayload} instance.
     *
     * @param bundle The data for converting.
     * @return The prepared {@link NotificationPayload} instance.
     */
    @Nullable
    NotificationPayload prepare(@NonNull final Bundle bundle);
}