com.enonic.xp.suggester.Suggestions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core-api Show documentation

core-api

The newest version!

package com.enonic.xp.suggester;

import java.util.LinkedHashSet;
import java.util.Set;

import com.google.common.collect.ImmutableSet;

import com.enonic.xp.annotation.PublicApi;
import com.enonic.xp.support.AbstractImmutableEntitySet;

@PublicApi
public class Suggestions
    extends AbstractImmutableEntitySet
{
    private static final Suggestions EMPTY = new Suggestions( ImmutableSet.of() );

    private Suggestions( final ImmutableSet set )
    {
        super( set );
    }

    public static Suggestions empty()
    {
        return EMPTY;
    }

    @Deprecated
    public static Suggestions from( final ImmutableSet suggestions )
    {
        return fromInternal( suggestions );
    }

    public static Suggestions from( final Iterable suggestions )
    {
        return fromInternal( ImmutableSet.copyOf( suggestions ) );
    }

    public static Suggestions from( final Suggestion... suggestions )
    {
        return fromInternal( ImmutableSet.copyOf( suggestions ) );
    }

    public Suggestion get( final String name )
    {
        return this.stream().filter( ( suggestion ) -> name.equals( suggestion.getName() ) ).findFirst().orElse( null );
    }

    private static Suggestions fromInternal( final ImmutableSet set )
    {
        return set.isEmpty() ? EMPTY : new Suggestions( set );
    }

    public static Builder create()
    {
        return new Builder();
    }

    public static class Builder
    {
        private final Set suggestions = new LinkedHashSet<>();

        public Builder add( final Suggestion suggestion )
        {
            this.suggestions.add( suggestion );
            return this;
        }

        public Suggestions build()
        {
            return fromInternal( ImmutableSet.copyOf( suggestions ) );
        }
    }
}