com.cronutils.model.field.definition.FieldSpecialCharsDefinitionBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cron-utils Show documentation

A Java library to parse, migrate and validate crons as well as describe them in human readable language

There is a newer version: 9.2.1

/*
 * Copyright 2014 jmrozanec
 * 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.cronutils.model.field.definition;

import com.cronutils.model.definition.CronDefinitionBuilder;
import com.cronutils.model.field.CronFieldName;

/**
 * Builder that allows to specify properties for a cron field supporting non-standard characters.
 */
public class FieldSpecialCharsDefinitionBuilder extends FieldQuestionMarkDefinitionBuilder {

    /**
     * Constructor.
     *
     * @param parserBuilder - ParserDefinitionBuilder
     * @param fieldName     - CronFieldName
     */
    public FieldSpecialCharsDefinitionBuilder(final CronDefinitionBuilder parserBuilder, final CronFieldName fieldName) {
        super(parserBuilder, fieldName);
    }

    /**
     * Registers the field supports the hash (#) special char.
     *
     * @return this FieldSpecialCharsDefinitionBuilder instance
     */
    public FieldSpecialCharsDefinitionBuilder supportsHash() {
        constraints.addHashSupport();
        return this;
    }

    /**
     * Registers the field supports the L (L) special char.
     *
     * @return this FieldSpecialCharsDefinitionBuilder instance
     */
    public FieldSpecialCharsDefinitionBuilder supportsL() {
        constraints.addLSupport();
        return this;
    }

    /**
     * Registers the field supports the W (W) special char.
     *
     * @return this FieldSpecialCharsDefinitionBuilder instance
     */
    public FieldSpecialCharsDefinitionBuilder supportsW() {
        constraints.addWSupport();
        return this;
    }

    /**
     * Registers the field supports the LW (LW) special char.
     *
     * @return this FieldSpecialCharsDefinitionBuilder instance
     */
    public FieldSpecialCharsDefinitionBuilder supportsLW() {
        constraints.addLWSupport();
        return this;
    }

    /**
     * Defines mapping between integer values with equivalent meaning.
     *
     * @param source - higher value
     * @param dest   - lower value with equivalent meaning to source
     * @return this FieldSpecialCharsDefinitionBuilder instance
     */
    @Override
    public FieldSpecialCharsDefinitionBuilder withIntMapping(final int source, final int dest) {
        super.withIntMapping(source, dest);
        return this;
    }

    /**
     * Allows to set a range of valid values for field.
     *
     * @param startRange - start range value
     * @param endRange   - end range value
     * @return same FieldSpecialCharsDefinitionBuilder instance
     */
    @Override
    public FieldSpecialCharsDefinitionBuilder withValidRange(final int startRange, final int endRange) {
        super.withValidRange(startRange, endRange);
        return this;
    }
}