bt.bencoding.model.rule.Rule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bt-bencoding Show documentation

Library for parsing, encoding and validating bencoded documents in Java

There is a newer version: 1.10

/*
 * Copyright (c) 2016—2017 Andrei Tomashpolskiy and individual contributors.
 *
 * 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 bt.bencoding.model.rule;

/**
 * Validation primitive. Checks some condition on a given object.
 *
 * @since 1.0
 */
public interface Rule {

    /**
     * Validate a given object.
     *
     * @param object Arbitrary object
     * @return true if the object satisfies this rule's condition.
     * @since 1.0
     */
    boolean validate(Object object);

    /**
     * @return Human-readable description of this rule.
     * @since 1.0
     */
    String getDescription();
}