javascalautils.Left Maven / Gradle / Ivy
/**
* Copyright 2015 Peter Nerg
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package javascalautils;
import static javascalautils.EitherCompanion.Right;
import java.io.Serializable;
import java.util.function.Function;
/**
* Represents the {@link Left} side of an {@link Either}.
*
* @author Peter Nerg
* @since 1.1
* @param
* The type for the {@link Left} side
* @param
* The type for the {@link Right} side (not used for this class)
*/
public final class Left implements Either, Serializable {
private static final long serialVersionUID = 6415576974626280469L;
private final L value;
/**
* Creates an instance wrapping the provide value.
*
* @param value
* The value wrapped by this instance
* @since 1.1
*/
public Left(L value) {
this.value = value;
}
/**
* Applies the provided func_left to the wrapped value and returns the result.
*
* @since 1.1
*/
@Override
public T fold(Function func_left, Function func_right) {
return func_left.apply(value);
}
/**
* Always returns false.
*
* @since 1.1
*/
@Override
public boolean isRight() {
return false;
}
/**
* Returns a {@link Right} containing the value for this instance.
*
* @since 1.1
*/
@Override
public Either swap() {
return Right(value);
}
/**
* Returns a String representation of the instance.
*
* @since 1.1
*/
@Override
public String toString() {
return "Left:" + value;
}
}