org.cp.elements.util.search.AbstractMatcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cp-elements Show documentation

Java Simplified. Extensions and Useful Constructs for the Java Platform. Codeprimate Elements (a.k.a. cp-elements) is a Java library and micro-framework used to simplify the development of software applications written in Java. Elements packages several APIs into one library in order to address various application concerns and aspects of software design and development collectively and conveniently. Elements is a highly simple, yet robust and proven library built on solid OO principles, software design patterns and best practices to effectively solve common and reoccurring problems in software development.

There is a newer version: 2.0.0-M1

Show newest version

/*
 * Copyright 2016 Author or Authors.
 *
 * 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 org.cp.elements.util.search;

/**
 * The AbstractMatcher class is abstract base class encapsulating functionality common to all Matcher implementations.
 *
 * @author John J. Blum
 * @see org.cp.elements.util.search.Matcher
 * @since 1.0.0
 */
@SuppressWarnings("unused")
public abstract class AbstractMatcher implements Matcher {

  /**
   * Determines whether the specified object is "accepted", or matched by the criteria defined by this Matcher.
   *
   * @param obj the Object being evaluated as a possible match to the criteria of this Matcher.
   * @return a boolean value indicating whether the specified object is "accepted", or matched by the criteria
   * defined by this Matcher.
   * @see #isMatch(Object)
   */
  @Override
  public boolean accept(final T obj) {
    return isMatch(obj);
  }

  /**
   * Determines whether the specified object is an exact match to the criteria defined by this Matcher.
   *
   * @param obj the Object being evaluated as a possible match to the criteria of this Matcher.
   * @return a boolean value indicating whether the specified object is an exact match to the criteria
   * defined by this Matcher.
   * @see #match(Object)
   */
  @Override
  public boolean isMatch(final T obj) {
    return (match(obj) == 0);
  }

}