1 /*
2 * *************************************************************************************************************************************************************
3 *
4 * TheseFoolishThings: Miscellaneous utilities
5 * http://tidalwave.it/projects/thesefoolishthings
6 *
7 * Copyright (C) 2009 - 2025 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 the License.
12 * 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 an "AS IS" BASIS, WITHOUT WARRANTIES OR
17 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
18 *
19 * *************************************************************************************************************************************************************
20 *
21 * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
22 * git clone https://github.com/tidalwave-it/thesefoolishthings-src
23 *
24 * *************************************************************************************************************************************************************
25 */
26 package it.tidalwave.role;
27
28 /***************************************************************************************************************************************************************
29 *
30 * The role of an object that can be removed (e.g. deleted).
31 *
32 * @stereotype Role
33 *
34 * @author Fabrizio Giudici
35 * @it.tidalwave.javadoc.stable
36 *
37 **************************************************************************************************************************************************************/
38 @FunctionalInterface
39 public interface Removable
40 {
41 public static final Class<Removable> _Removable_ = Removable.class;
42
43 /***********************************************************************************************************************************************************
44 * A default {@code Removable} which does nothing (useful for implementing the NullObject pattern).
45 **********************************************************************************************************************************************************/
46 public static final Removable DEFAULT = () -> {};
47
48 /***********************************************************************************************************************************************************
49 * Removes this object from some implicit, or context-provided container (e.g. a persistence facility, etc...).
50 * @throws Exception if the operation fails
51 **********************************************************************************************************************************************************/
52 @SuppressWarnings("RedundantThrows")
53 public void remove()
54 throws Exception;
55 }