Package: StorableField

StorableField

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2016, 2022 Eurotech and/or its affiliates and others
3: *
4: * This program and the accompanying materials are made
5: * available under the terms of the Eclipse Public License 2.0
6: * which is available at https://www.eclipse.org/legal/epl-2.0/
7: *
8: * SPDX-License-Identifier: EPL-2.0
9: *
10: * Contributors:
11: * Eurotech - initial API and implementation
12: *******************************************************************************/
13: package org.eclipse.kapua.service.storable.model.query;
14:
15: import org.eclipse.kapua.service.storable.model.Storable;
16:
17: /**
18: * {@link StorableField }definition.
19: * <p>
20: * It identifies one of the fields of {@link Storable}
21: *
22: * @since 1.0.0
23: */
24: public interface StorableField {
25:
26: /**
27: * Gets the {@link Storable} field name.
28: *
29: * @return The {@link Storable} field name.
30: * @since 1.0.0
31: */
32: String field();
33:
34: /**
35: * Watch out using this to get the {@link StorableField} actual name.
36: * Maybe {@link #field()} is what you are looking for!
37: *
38: * @return The {@link Enum#name()}
39: * @since 1.3.0
40: * @deprecated Since the beginning.
41: */
42: @Deprecated
43: String name();
44: }