01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * 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: * Calculates and returns an object that represents the state of the field value.
33: * The states produced by this method will be used to check whether the field
34: * is dirty at synchronization time.
35: *
36: * @param fieldValue field's value.
37: * @return an object representing the field's state.
38: */
39: Object getFieldState(Object fieldValue);
40:
41: /**
42: * Checks whether the field's state <code>state</code>
43: * is equal to the field value's state (possibly, calculated with
44: * the <code>getFieldState()</code> method).
45: *
46: * @param state the state to compare with field value's state.
47: * @param fieldValue field's value, the state of which will be compared
48: * with <code>state</code>.
49: * @return true if <code>state</code> equals to <code>fieldValue</code>'s state.
50: */
51: boolean isStateValid(Object state, Object fieldValue);
52: }
|