com.enonic.xp.macro.Macro 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.macro;

import java.util.Objects;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ImmutableMap;

import com.enonic.xp.annotation.PublicApi;

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

    private final String body;

    private final ImmutableListMultimap params;

    private Macro( final Builder builder )
    {
        this.name = builder.name;
        this.body = builder.body == null ? "" : builder.body;
        this.params = builder.paramsBuilder.build();
    }

    public String getName()
    {
        return name;
    }

    public String getBody()
    {
        return body;
    }

    @Deprecated
    public String getParam( final String name )
    {
        final ImmutableList values = this.params.get( name );
        return values.isEmpty() ? null : String.join( ",", values );
    }

    @Deprecated
    public ImmutableMap getParams()
    {
        final ImmutableMap.Builder mapParams = ImmutableMap.builder();
        for ( String key : this.params.keySet() )
        {
            final String value = String.join( ",", this.params.get( key ) );
            mapParams.put( key, value );
        }
        return mapParams.build();
    }

    public ImmutableList getParameter( final String name )
    {
        return this.params.get( name );
    }

    public ImmutableListMultimap getParameters()
    {
        return params;
    }

    @Override
    public boolean equals( final Object o )
    {
        if ( this == o )
        {
            return true;
        }
        if ( o == null || getClass() != o.getClass() )
        {
            return false;
        }

        final Macro that = (Macro) o;
        return Objects.equals( this.name, that.name ) && Objects.equals( this.body, that.body ) && this.params.equals( that.params );
    }

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

    @Override
    public String toString()
    {
        final StringBuilder result = new StringBuilder( "[" ).append( name );
        if ( params.isEmpty() && body.isEmpty() )
        {
            result.append( "/]" );
        }
        else
        {
            for ( String paramName : params.keySet() )
            {
                for ( String value : params.get( paramName ) )
                {
                    result.append( " " ).append( paramName ).append( "=\"" );
                    result.append( escapeParam( value ) );
                    result.append( "\"" );
                }
            }
            if ( body.isEmpty() )
            {
                result.append( "/]" );
            }
            else
            {
                result.append( "]" ).append( body ).append( "[/" ).append( name ).append( "]" );
            }
        }
        return result.toString();
    }

    private String escapeParam( final String value )
    {
        return value.replace( "\\", "\\\\" ).replace( "\"", "\\\"" );
    }

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

    public static Builder copyOf( final Macro macro )
    {
        return new Builder( macro );
    }

    public static class Builder
    {

        private String name;

        private String body;

        private final ImmutableListMultimap.Builder paramsBuilder;

        public Builder()
        {
            this.paramsBuilder = ImmutableListMultimap.builder();
        }

        private Builder( final Macro macro )
        {
            this.name = macro.name;
            this.body = macro.body;
            this.paramsBuilder = ImmutableListMultimap.builder();
            this.paramsBuilder.putAll( macro.params );
        }

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

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

        public Builder param( final String key, final String value )
        {
            this.paramsBuilder.put( key, value );
            return this;
        }

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