xy.reflect.ui.info.filter.IInfoFilter Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (C) 2018 OTK Software
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * The GNU General Public License allows you also to freely redistribute 
 * the libraries under the same license, if you provide the terms of the 
 * GNU General Public License with them and add the following 
 * copyright notice at the appropriate place (with a link to 
 * http://javacollection.net/reflectionui/ web site when possible).
 ******************************************************************************/
package xy.reflect.ui.info.filter;

import xy.reflect.ui.info.field.IFieldInfo;
import xy.reflect.ui.info.method.IMethodInfo;

/**
 * This interface allows to specify objects used to dynamically filter out some
 * fields and methods from the display.
 * 
 * @author olitank
 *
 */
public interface IInfoFilter {

	public IInfoFilter DEFAULT = new IInfoFilter() {

		@Override
		public boolean excludeField(IFieldInfo field) {
			return false;
		}

		@Override
		public boolean excludeMethod(IMethodInfo method) {
			return false;
		}

		@Override
		public String toString() {
			return IInfoFilter.class.getName() + ".DEFAULT";
		}

	};

	/**
	 * @param field
	 *            The field to be filtered out.
	 * @return true if the given field is filtered out from the display.
	 */
	boolean excludeField(IFieldInfo field);

	/**
	 * @param method
	 *            The method to be filtered out.
	 * @return true if the given method is filtered out from the display.
	 */
	boolean excludeMethod(IMethodInfo method);

}