dev.amp.validator.UrlErrorInAttrAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of validator-java Show documentation
A Java validator for the AMP Html format.
There is a newer version: 1.0.42
/*
 *
 * ====================================================================
 * 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.
 *  ====================================================================
 */

/*
 * Changes to the original project are Copyright 2019, Yahoo Inc..
 */

package dev.amp.validator;

import dev.amp.validator.utils.TagSpecUtils;

import javax.annotation.Nonnull;
import java.util.ArrayList;
import java.util.List;

/**
 * URL error in attribute adaptor.
 *
 * @author nhant01
 * @author GeorgeLuo
 */

public class UrlErrorInAttrAdapter implements UrlErrorAdapter {
    /**
     * Constructor.
     * @param attrName attribute name.
     */
    public UrlErrorInAttrAdapter(@Nonnull final String attrName) {
        this.attrName = attrName;
    }

    /**
     * Adding missing url validation error.
     *
     * @param context context.
     * @param tagSpec tag spec.
     * @param result validation result.
     */
    @Override
    public void missingUrl(@Nonnull final Context context,
                           @Nonnull final ValidatorProtos.TagSpec tagSpec,
                           @Nonnull final  ValidatorProtos.ValidationResult.Builder result) {
        final List params = new ArrayList<>();
        params.add(this.attrName);
        params.add(TagSpecUtils.getTagSpecName(tagSpec));
        context.addError(
                ValidatorProtos.ValidationError.Code.MISSING_URL,
                context.getLineCol(),
                /* params */params,
                TagSpecUtils.getTagSpecUrl(tagSpec),
                result);
    }

    /**
     * Adding invalid url validation error.
     *
     * @param context context.
     * @param url the url.
     * @param tagSpec tag spec.
     * @param result validation result.
     */
    @Override
    public void invalidUrl(@Nonnull final Context context,
                           @Nonnull final String url,
                           @Nonnull final ValidatorProtos.TagSpec tagSpec,
                           @Nonnull final  ValidatorProtos.ValidationResult.Builder result) {
        final List params = new ArrayList<>();
        params.add(this.attrName);
        params.add(TagSpecUtils.getTagSpecName(tagSpec));
        params.add(url);
        context.addError(
                ValidatorProtos.ValidationError.Code.INVALID_URL,
                context.getLineCol(),
                /* params */params,
                TagSpecUtils.getTagSpecUrl(tagSpec),
                result);
    }

    /**
     * Adding invalid url protocol error.
     *
     * @param context context.
     * @param protocol the protocol.
     * @param tagSpec tag spec.
     * @param result validation result.
     */
    @Override
    public void invalidUrlProtocol(@Nonnull final Context context,
                       @Nonnull final String protocol,
                       @Nonnull final ValidatorProtos.TagSpec tagSpec,
                       @Nonnull final  ValidatorProtos.ValidationResult.Builder result) {
        final List params = new ArrayList<>();
        params.add(this.attrName);
        params.add(TagSpecUtils.getTagSpecName(tagSpec));
        params.add(protocol);
        context.addError(
                ValidatorProtos.ValidationError.Code.INVALID_URL_PROTOCOL,
                context.getLineCol(),
                /* params */params,
                TagSpecUtils.getTagSpecUrl(tagSpec),
                result);
    }

    /**
     * Adding disallowed relative url error.
     *
     * @param context context.
     * @param url the url.
     * @param tagSpec tag spec.
     * @param result validation result.
     */
    @Override
    public void disallowedRelativeUrl(@Nonnull final Context context,
                          @Nonnull final String url,
                          @Nonnull final ValidatorProtos.TagSpec tagSpec,
                          @Nonnull final  ValidatorProtos.ValidationResult.Builder result) {
        final List params = new ArrayList<>();
        params.add(this.attrName);
        params.add(TagSpecUtils.getTagSpecName(tagSpec));
        params.add(url);
        context.addError(
                ValidatorProtos.ValidationError.Code.DISALLOWED_RELATIVE_URL,
                context.getLineCol(),
                /* params */params,
                TagSpecUtils.getTagSpecUrl(tagSpec),
                result);
    }

    /** Attribute name. */
    private final String attrName;
}