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

import com.enonic.xp.annotation.PublicApi;
import com.enonic.xp.data.PropertyTree;
import com.enonic.xp.page.DescriptorKey;

@PublicApi
public abstract class DescriptorBasedComponent
    extends Component
{
    private final DescriptorKey descriptor;

    private final PropertyTree config;

    protected DescriptorBasedComponent( final Builder builder )
    {
        super( builder );
        this.descriptor = builder.descriptor;
        this.config = builder.config != null ? builder.config : new PropertyTree();
    }

    public DescriptorKey getDescriptor()
    {
        return descriptor;
    }

    public boolean hasDescriptor()
    {
        return descriptor != null;
    }

    public boolean hasConfig()
    {
        return config != null && config.getTotalSize() > 0;
    }

    public PropertyTree getConfig()
    {
        return config;
    }

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

        final DescriptorBasedComponent that = (DescriptorBasedComponent) o;

        return Objects.equals( descriptor, that.descriptor ) && Objects.equals( config, that.config );
    }

    @Override
    public int hashCode()
    {
        return Objects.hash( super.hashCode(), config, descriptor );
    }

    public static class Builder
        extends Component.Builder
    {
        protected DescriptorKey descriptor;

        protected PropertyTree config;

        protected Builder()
        {
            // Default
        }

        protected Builder( final DescriptorBasedComponent source )
        {
            super( source );
            this.config = source.getConfig() != null ? source.getConfig().copy() : null;
            this.descriptor = source.getDescriptor();
        }

        @Deprecated
        @Override
        public Builder name( ComponentName value )
        {
            return this;
        }

        public Builder descriptor( DescriptorKey value )
        {
            this.descriptor = value;
            return this;
        }

        public Builder config( final PropertyTree config )
        {
            this.config = config;
            return this;
        }
    }
}