com.aol.cyclops.featuretoggle.Enabled Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cyclops-feature-toggle Show documentation

Enabled / Disabled monad (extends javaslang.control.Either)

There is a newer version: 7.2.4

Show newest version

package com.aol.cyclops.featuretoggle;

import java.util.Objects;
import java.util.Optional;

import lombok.Value;

import com.aol.cyclops.monad.AnyM;

/**
 * An enabled switch
 * 
 *  * 
 * Switch<Data> data = Switch.enabled(data);
 * 
 * data.map(this::load);  //data will be loaded because Switch is of type Enabled
 * 
 * 
 * @author johnmcclean
 *
 * @param  Type of value Enabled Switch holds
 */
@Value
public class Enabled implements FeatureToggle{

	
	
   

	private final F enabled;
	/**
	 * @return This monad, wrapped as AnyM
	 */
	public AnyM anyM(){
		return AnyM.fromStreamable(this);
	}
	/**
	 * @return This monad, wrapped as AnyM of Disabled
	 */
	public AnyM anyMDisabled(){
		return  AnyM.ofMonad(Optional.empty());
	}
	/**
	 * @return This monad, wrapped as AnyM of Enabled
	 */
	public AnyM anyMEnabled(){
		return anyM();
	}
	/**
	 * Create a new enabled switch
	 * 
	 * @param f switch value
	 * @return enabled switch
	 */
	public static  Enabled of(F f){
		return new Enabled(f);
	}
	/**
	 * Create a new enabled switch
	 * 
	 * @param f switch value
	 * @return enabled switch
	 */
	public static  AnyM anyMOf(F f){
		return new Enabled(f).anyM();
	}
    /* 
     *	@return
     * @see com.aol.cyclops.enableswitch.Switch#get()
     */
    public F get(){
    	return enabled;
    }
    
    /**
     * Constructs an Enabled Switch
     *
     * @param enabled The value of this Enabled Switch
     */
    public Enabled(F enabled) {
       this.enabled = enabled;
    }
    
    
    /* 
     * @param obj to check equality with
     * @return whether objects are equal
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj) {
        return (obj == this) || (obj instanceof Enabled && Objects.equals(enabled, ((Enabled) obj).enabled));
    }

    /* 
     *
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        return Objects.hashCode(enabled);
    }

    /*  
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return String.format("Enabled(%s)", enabled );
    }

	/* 
	 *	@return true - is Enabled
	 * @see com.aol.cyclops.enableswitch.Switch#isEnabled()
	 */
	@Override
	public final boolean isEnabled() {
		return true;
	}

	/* 
	 *	@return false - is not Disabled
	 * @see com.aol.cyclops.enableswitch.Switch#isDisabled()
	 */
	@Override
	public final boolean isDisabled() {
		
		return false;
	}
}