com.tomtom.speedtools.apivalidation.errors.ApiParameterSyntaxError Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apivalidation Show documentation

Support for DTOs (data transfer objects ) in your API with support for specific API parameter validation (if you don't wish to use the JSR one).

The newest version!

/*
 * Copyright (C) 2012-2021, TomTom (http://tomtom.com).
 *
 * 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.tomtom.speedtools.apivalidation.errors;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public final class ApiParameterSyntaxError extends ApiValidationError {

    @Nonnull
    private final String parameter;
    @Nullable
    private final String actual;
    @Nonnull
    private final String format;
    @Nullable
    private final String description;

    public ApiParameterSyntaxError(
            @Nonnull final String parameter,
            @Nullable final String actual,
            @Nonnull final String format) {
        this(parameter, actual, format, null);
    }

    public ApiParameterSyntaxError(
            @Nonnull final String parameter,
            @Nullable final String actual,
            @Nonnull final String format,
            @Nullable final String description) {
        super(ErrorCode.STRING_FORMAT_ERROR);
        assert parameter != null;
        assert format != null;
        this.parameter = parameter;
        this.actual = actual;
        this.format = format;
        this.description = description;
    }

    /**
     * Required by JAX-B, see {@link ApiValidationError}.
     */
    @SuppressWarnings({"ConstantConditions", "deprecation"})
    @Deprecated
    public ApiParameterSyntaxError() {
        super();
        this.parameter = null;
        this.actual = null;
        this.format = null;
        this.description = null;
    }

    @Nonnull
    public String getParameter() {
        return parameter;
    }

    @Nullable
    public String getActual() {
        return actual;
    }

    @Nonnull
    public String getFormat() {
        return format;
    }

    @Nullable
    public String getDescription() {
        return description;
    }
}