io.sphere.sdk.channels.ChannelDraft Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sphere-models Show documentation

sphere-models

There is a newer version: 1.0.0-M26

package io.sphere.sdk.channels;

import com.fasterxml.jackson.annotation.JsonInclude;
import io.sphere.sdk.models.Base;
import io.sphere.sdk.models.LocalizedString;

import javax.annotation.Nullable;
import java.util.Collections;
import java.util.Set;

import static io.sphere.sdk.utils.SetUtils.asSet;

/**
 * Template to create a new Channel.
 *
 * {@include.example io.sphere.sdk.channels.commands.ChannelCreateCommandTest#execution()}
 *
 * @see ChannelDraftBuilder
 */
public class ChannelDraft extends Base {
    private final String key;
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    @Nullable
    private final Set roles;
    @Nullable
    private final LocalizedString name;
    @Nullable
    private final LocalizedString description;

    ChannelDraft(final String key, final Set roles, @Nullable final LocalizedString name, @Nullable final LocalizedString description) {
        this.key = key;
        this.roles = roles;
        this.name = name;
        this.description = description;
    }

    public static ChannelDraft of(final String key) {
        return new ChannelDraft(key, Collections.emptySet(), null, null);
    }

    public String getKey() {
        return key;
    }

    public Set getRoles() {
        return roles;
    }

    @Nullable
    public LocalizedString getName() {
        return name;
    }

    @Nullable
    public LocalizedString getDescription() {
        return description;
    }
    
    public ChannelDraft withRoles(@Nullable final Set roles) {
        return newBuilder().roles(roles).build();
    }

    public ChannelDraft withRoles(final ChannelRole ... roles) {
        return newBuilder().roles(asSet(roles)).build();
    }
    
    public ChannelDraft withName(@Nullable final LocalizedString name) {
        return newBuilder().name(name).build();
    }

    public ChannelDraftBuilder newBuilder() {
        return ChannelDraftBuilder.of(this);
    }

    public ChannelDraft withDescription(@Nullable final LocalizedString description) {
        return newBuilder().description(description).build();
    }
}