com.enonic.xp.region.Region 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.region;


import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

import com.google.common.base.MoreObjects;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;

import com.enonic.xp.annotation.PublicApi;

@PublicApi
public final class Region
{
    private final String name;

    private final ImmutableList components;

    private LayoutComponent parent;

    public Region( final Builder builder )
    {
        Preconditions.checkNotNull( builder.name, "name cannot be null" );
        this.name = builder.name;
        this.parent = builder.parent;
        this.components = ImmutableList.copyOf( builder.components );

        for ( final Component component : this.components )
        {
            boolean layoutComponentWithinLayoutComponent = this.parent != null && component instanceof LayoutComponent;
            if ( layoutComponentWithinLayoutComponent )
            {
                throw new IllegalArgumentException( "Having a LayoutComponent within a LayoutComponent is not allowed" );
            }
            component.setRegion( this );
        }
    }

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

    public static Builder create( final Region source )
    {
        return new Builder( source );
    }

    public Region copy()
    {
        return Region.create( this ).build();
    }

    public String getName()
    {
        return name;
    }

    public void setParent( LayoutComponent parent )
    {
        this.parent = parent;
        for ( final Component component : this.components )
        {
            boolean layoutComponentWithinLayoutComponent = this.parent != null && component instanceof LayoutComponent;
            if ( layoutComponentWithinLayoutComponent )
            {
                throw new IllegalArgumentException( "Having a LayoutComponent within a LayoutComponent is not allowed" );
            }
        }
    }

    public int getIndex( final Component component )
    {
        for ( int i = 0; i < components.size(); i++ )
        {
            if ( component == components.get( i ) )
            {
                return i;
            }
        }
        return -1;
    }

    public RegionPath getRegionPath()
    {
        return RegionPath.from( parent != null ? parent.getPath() : null, name );
    }

    public Component getComponent( final int index )
    {
        if ( index >= this.components.size() )
        {
            return null;
        }
        return this.components.get( index );
    }

    public ImmutableList getComponents()
    {
        return components;
    }

    @Override
    public boolean equals( final Object o )
    {
        if ( this == o )
        {
            return true;
        }
        if ( !( o instanceof Region ) )
        {
            return false;
        }

        final Region region = (Region) o;

        return Objects.equals( name, region.name ) && Objects.equals( components, region.components );
    }

    @Override
    public int hashCode()
    {
        return Objects.hash( name, components );
    }

    @Override
    public String toString()
    {
        return MoreObjects.toStringHelper( this ).
            add( "name", name ).
            add( "parent", parent == null ? null : parent.getDescriptor() ).
            add( "components", components ).
            toString();
    }

    public static class Builder
    {
        private String name;

        private LayoutComponent parent;

        private final List components = new ArrayList<>();

        public Builder()
        {

        }

        public Builder( final Region source )
        {
            this.name = source.name;
            for ( final Component component : source.components )
            {
                this.components.add( component.copy() );
            }
            this.parent = source.parent;
        }

        public Builder name( final String value )
        {
            this.name = value;
            return this;
        }

        public Builder parent( final LayoutComponent value )
        {
            this.parent = value;
            return this;
        }

        public Builder add( final Component component )
        {
            this.components.add( component );
            return this;
        }

        public Builder set( final int index, final Component component )
        {
            this.components.set( index, component );
            return this;
        }

        public Region build()
        {
            return new Region( this );
        }

    }
}