1 package org.synchronoss.cpo.core;
2
3 /*-
4 * [[
5 * core
6 * ==
7 * Copyright (C) 2003 - 2026 Exaxis LLC, Synchronoss Technologies Inc
8 * ==
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation, either version 3 of the
12 * License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Lesser Public License for more details.
18 *
19 * You should have received a copy of the GNU General Lesser Public
20 * License along with this program. If not, see
21 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22 * ]]
23 */
24
25 import org.synchronoss.cpo.core.meta.domain.CpoAttribute;
26
27 /**
28 * {@code BindAttribute} pairs a single bind value produced while walking a {@link CpoWhere} tree
29 * (see {@link BindableWhereBuilder}) with either the resolved {@link CpoAttribute} it belongs to,
30 * or, when no matching bean attribute exists, the raw attribute name it was addressed by.
31 *
32 * @param cpoAttribute the resolved bean attribute this value should be bound to, or {@code null} if
33 * this instance was created with a raw name instead
34 * @param bindObject the value to bind
35 * @param name the raw attribute or column name this value should be bound to, or {@code null} if
36 * this instance was created with a resolved {@link CpoAttribute} instead
37 * @author david.berry
38 */
39 public record BindAttribute(CpoAttribute cpoAttribute, Object bindObject, String name) {
40
41 /**
42 * Creates an instance bound to a resolved bean attribute.
43 *
44 * @param cpoAttribute the attribute this value should be bound to
45 * @param bindObject the value to bind
46 */
47 public BindAttribute(CpoAttribute cpoAttribute, Object bindObject) {
48 this(cpoAttribute, bindObject, null);
49 }
50
51 /**
52 * Creates an instance for a value that has no matching bean attribute, identified instead by name
53 * (for example, a raw column name used directly in a where clause).
54 *
55 * @param name the attribute or column name this value should be bound to
56 * @param bindObject the value to bind
57 */
58 public BindAttribute(String name, Object bindObject) {
59 this(null, bindObject, name);
60 }
61 }