net.sf.mmm.util.pojo.api.PojoUtil Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mmm-util-pojo Show documentation

This project provides common utitlities to for POJOs.

There is a newer version: 8.7.0

/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package net.sf.mmm.util.pojo.api;

import java.util.Set;

import net.sf.mmm.util.component.api.ComponentSpecification;
import net.sf.mmm.util.filter.api.Filter;

/**
 * This is the interface for a collection of utility functions to deal with {@link Pojo POJOs}.
 *
 * @see net.sf.mmm.util.pojo.descriptor.api.PojoDescriptorBuilder
 * @see net.sf.mmm.util.reflect.api.ReflectionUtil
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 7.1.0
 */
@ComponentSpecification
public interface PojoUtil {

  /**
   * This method recursively traverses all objects starting from the given {@link Object} via all properties
   * and contents. It simply delegates to {@link #visitObjectRecursive(Object, Filter, boolean)} using
   * {@code true} for {@code loopProtection}.
   *
   * @param object is the {@link Object} to traverse recursively.
   * @param visitor is the {@link Filter} {@link Filter#accept(Object) invoked} for all traversed
   *        {@link Object}s. If an {@link Object} is not {@link Filter#accept(Object) accepted} by this
   *        {@link Filter} the recursion stops at this point.
   */
  void visitObjectRecursive(Object object, Filter