org.apache.nifi.components.Validator Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.nifi.components;
/**
*
*/
public interface Validator {
/**
* Validator object providing validation behavior in which validation always
* fails
*/
Validator INVALID = new Validator() {
@Override
public ValidationResult validate(final String subject, final String input, final ValidationContext context) {
return new ValidationResult.Builder().subject(subject).explanation(String.format("'%s' is not a supported property or has no Validator associated with it", subject)).input(input).build();
}
};
/**
* Validator object providing validation behavior in which validation always
* passes
*/
Validator VALID = new Validator() {
@Override
public ValidationResult validate(final String subject, final String input, final ValidationContext context) {
return new ValidationResult.Builder().subject(subject).input(input).valid(true).build();
}
};
/**
* @param subject what is being validated
* @param input the string to be validated
* @param context the ValidationContext to use when validating properties
* @return ValidationResult
* @throws NullPointerException of given input is null
*/
ValidationResult validate(String subject, String input, ValidationContext context);
}