Skip to contentPackage: Removable
Removable
Coverage
1: /*
2: * *********************************************************************************************************************
3: *
4: * TheseFoolishThings: Miscellaneous utilities
5: * http://tidalwave.it/projects/thesefoolishthings
6: *
7: * Copyright (C) 2009 - 2023 by Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *********************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
12: * the License. You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
23: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.role;
28:
29: /***********************************************************************************************************************
30: *
31: * The role of an object that can be removed (e.g. deleted).
32: *
33: * @stereotype Role
34: *
35: * @author Fabrizio Giudici
36: * @it.tidalwave.javadoc.stable
37: *
38: **********************************************************************************************************************/
39: @FunctionalInterface
40: public interface Removable
41: {
42: public static final Class<Removable> _Removable_ = Removable.class;
43:
44: /*******************************************************************************************************************
45: *
46: * A default {@code Removable} which does nothing (useful for implementing the NullObject pattern).
47: *
48: ******************************************************************************************************************/
49: public static final Removable DEFAULT = () -> {};
50:
51: /*******************************************************************************************************************
52: *
53: * Removes this object from some implicit, or context-provided container (e.g. a persistence facility, etc...).
54: *
55: * @throws Exception if the operation fails
56: *
57: ******************************************************************************************************************/
58: public void remove()
59: throws Exception;
60: }