travel.izi.api.model.entity.Playback Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2014 IZITEQ B.V.
 *
 * 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 travel.izi.api.model.entity;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
import com.google.auto.value.AutoValue;
import travel.izi.api.model.enumeration.PlaybackType;

import javax.annotation.Nullable;
import java.io.Serializable;
import java.util.List;

/**
 * MTGObjects playback algorithm settings.
 */
@SuppressWarnings("unused")
@AutoValue
@JsonDeserialize(builder = AutoValue_Playback.Builder.class)
public abstract class Playback implements Serializable {

    public static Builder builder() {
        return new AutoValue_Playback.Builder();
    }

    /**
     * Describes how to play data inside MTGObject and its children.
     */
    public abstract PlaybackType type();

    /**
     * List of UUIDs. Defines playback order of children MTGObjects. If set, a mobile application
     * can use this data for making decisions which story to play. The first array element is
     * the starting object to play.
     */
    @Nullable
    public abstract List order();

    /**
     * An array of ordered Segment objects for quest playback type.
     */
    @Nullable
    public abstract List segments();

    @AutoValue.Builder
    @JsonPOJOBuilder(withPrefix = "")
    public abstract static class Builder {
        public abstract Builder type(PlaybackType type);
        public abstract Builder order(List order);
        public abstract Builder segments(List segments);

        public abstract Playback build();
    }
}