com.shapesecurity.functional.data.Monoid Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of shape-functional-java Show documentation
Functional programming library
There is a newer version: 3.1.0
Show newest version
/*
 * Copyright 2014 Shape Security, Inc.
 *
 * 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 com.shapesecurity.functional.data;

import com.shapesecurity.functional.Unit;

import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;

@CheckReturnValue
public interface Monoid extends Semigroup {
    public static final UnitIdentity UNIT = new UnitIdentity();
    public static final IntegerAdditive INTEGER_ADDITIVE = new IntegerAdditive();
    public static final IntegerMultiplicative INTEGER_MULTIPLICATIVE = new IntegerMultiplicative();
    public static final StringConcat STRING_CONCAT = new StringConcat();
    public static final BooleanOr BOOLEAN_OR = new BooleanOr();
    public static final BooleanAnd BOOLEAN_AND = new BooleanAnd();

    @Nonnull
    T identity();

    public static class UnitIdentity extends Semigroup.UnitIdentity implements Monoid {
        protected UnitIdentity() {
            super();
        }

        @Nonnull
        @Override
        public final Unit identity() {
            return Unit.unit;
        }
    }

    public static class IntegerAdditive extends Semigroup.IntegerAdditive implements Monoid {
        protected IntegerAdditive() {
            super();
        }

        @Nonnull
        @Override
        public final Integer identity() {
            return 0;
        }
    }

    public static class IntegerMultiplicative extends Semigroup.IntegerMultiplicative implements Monoid {
        protected IntegerMultiplicative() {
            super();
        }

        @Nonnull
        @Override
        public final Integer identity() {
            return 1;
        }
    }

    public static class StringConcat extends Semigroup.StringConcat implements Monoid {
        protected StringConcat() {
            super();
        }

        @Nonnull
        @Override
        public final String identity() {
            return "";
        }
    }

    public static class BooleanOr extends Semigroup.BooleanOr implements Monoid {
        protected BooleanOr() {
            super();
        }

        @Nonnull
        @Override
        public final Boolean identity() {
            return false;
        }
    }

    public static class BooleanAnd extends Semigroup.BooleanAnd implements Monoid {
        protected BooleanAnd() {
            super();
        }

        @Nonnull
        @Override
        public final Boolean identity() {
            return true;
        }
    }

    public class ImmutableListAppend implements Monoid> {
        @Nonnull
        @Override
        public ImmutableList append(ImmutableList ts, ImmutableList t1) {
            return ts.append(t1);
        }

        @Nonnull
        @Override
        public ImmutableList identity() {
            return ImmutableList.empty();
        }
    }

    public class ImmutableSetEqualityUnion implements Monoid> {
        @Nonnull
        @Override
        public ImmutableSet append(ImmutableSet ts, ImmutableSet t1) {
            return ts.union(t1);
        }

        @Nonnull
        @Override
        public ImmutableSet identity() {
            return ImmutableSet.emptyUsingEquality();
        }
    }

    public class ImmutableSetIdentityUnion implements Monoid> {
        @Nonnull
        @Override
        public ImmutableSet append(ImmutableSet ts, ImmutableSet t1) {
            return ts.union(t1);
        }

        @Nonnull
        @Override
        public ImmutableSet identity() {
            return ImmutableSet.emptyUsingIdentity();
        }
    }

    public class ConcatListAppend implements Monoid> {
        @Nonnull
        @Override
        public ConcatList append(ConcatList ts, ConcatList t1) {
            return ts.append(t1);
        }

        @Nonnull
        @Override
        public ConcatList identity() {
            return ConcatList.empty();
        }
    }
}