de.cuioss.tools.string.SplitterConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cui-java-tools Show documentation

Utility Library acting as a replacement for googles guava, certain apache-commons libraries and logging facades/frameworks.

There is a newer version: 2.1.1

Show newest version

/*
 * Copyright 2023 the original author or authors.
 * 
 * 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
 * 

 * https://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 de.cuioss.tools.string;

import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;

/**
 * Encapsulates configuration for the Splitter
 *
 * @author Oliver Wolff
 *
 */
@Builder
@EqualsAndHashCode
@ToString
@SuppressWarnings("squid:S1170") // owolff: False positive, sonar does not recognize Lomboks
                                 // Builder-Default annotations here
class SplitterConfig {

    @Getter
    private final String separator;

    @Builder.Default
    @Getter
    private final boolean omitEmptyStrings = false;

    @Builder.Default
    @Getter
    private final boolean trimResults = false;

    @Builder.Default
    @Getter
    private final int maxItems = 0;

    @Builder.Default
    @Getter
    private final boolean doNotModifySeparatorString = false;

    @SuppressWarnings("java:S2094")
    // owolff: workaround for javadoc-error, see
    // https://stackoverflow.com/questions/51947791/javadoc-cannot-find-symbol-error-when-using-lomboks-builder-annotation
    public static class SplitterConfigBuilder {
    }

    SplitterConfigBuilder copy() {
        var copyBuilder = builder();
        copyBuilder.separator(getSeparator()).maxItems(getMaxItems())
                .doNotModifySeparatorString(isDoNotModifySeparatorString()).omitEmptyStrings(isOmitEmptyStrings())
                .trimResults(isTrimResults());
        return copyBuilder;
    }
}