CMPFieldStateFactory


1   /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this software; if not, write to the Free
19  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21  */
22  package org.jboss.ejb.plugins.cmp.jdbc;
23  
24  /**
25   * Implementations of this interface are used to create and compare field states
26   * for equality.
27   *
28   * @author <a HREF="mailto:alex@jboss.org">Alexey Loubyansky</a>
29   */
30  public interface CMPFieldStateFactory
31  {
32     /**
33      * Calculates and returns an object that represents the state of the field value.
34      * The states produced by this method will be used to check whether the field
35      * is dirty at synchronization time.
36      *
37      * @param fieldValue  field's value.
38      * @return an object representing the field's state.
39      */
40     Object   getFieldState(Object   fieldValue);
41  
42     /**
43      * Checks whether the field's state <code>state</code>
44      * is equal to the field value's state (possibly, calculated with
45      * the <code>getFieldState()</code> method).
46      *
47      * @param state  the state to compare with field value's state.
48      * @param fieldValue  field's value, the state of which will be compared
49      *                    with <code>state</code>.
50      * @return  true if <code>state</code> equals to <code>fieldValue</code>'s state.
51      */
52     boolean isStateValid(Object   state, Object   fieldValue);
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags