com.openpojo.reflection.adapt.service.PojoClassAdaptationService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openpojo Show documentation

This project was born out of a need to validate all POJOs (Plain Old Java Object) are behaving correctly. This project has two main aspects to it: * Make Testing as easy as possible. * Simplifying identity management (hashCode / equals) using annotation.

There is a newer version: 0.7.3

Show newest version

/*
 * Copyright (c) 2010-2013 Osman Shoukry
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU Lesser General Public License as published by
 *    the Free Software Foundation, either version 3 of the License or 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 Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public License
 *    along with this program.  If not, see .
 */

package com.openpojo.reflection.adapt.service;

import com.openpojo.reflection.PojoClass;
import com.openpojo.reflection.adapt.PojoClassAdapter;

import java.util.Set;

/**
 * A service to modify PojoClasses.
 * The primary reason for usage should be to mask certain fields from being visible to downstream processes.
 * Can be used to make invisible certain constructors, or fields and their methods.
 *
 * @author oshoukry
 */
public interface PojoClassAdaptationService {

    /**
     * This method is used to register POJO class adapter.
     *
     * @param pojoClassAdapter
     *         The pojoClassAdapter to register.
     */
    public void registerPojoClassAdapter(PojoClassAdapter pojoClassAdapter);

    /**
     * Unregister a previously registered PojoClassAdapter.
     *
     * @param pojoClassAdapter
     *         the pojoClassAdapter to unregister
     */
    public void unRegisterPojoClassAdapter(PojoClassAdapter pojoClassAdapter);

    /**
     * @param pojoClass
     *         The pojoClass to modify.
     * @return processed PojoClass.
     */
    public PojoClass adapt(PojoClass pojoClass);

    /**
     * @return the set of registered pojo adapter classes.
     */
    public Set getRegisteredPojoAdapterClasses();
}