View Javadoc
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.util;
27  
28  import javax.annotation.Nonnull;
29  
30  /***************************************************************************************************************************************************************
31   *
32   * This interface should be implemented by classes for which is meaningful to be converted into a {@link String}.
33   *
34   * @author  Fabrizio Giudici
35   * @it.tidalwave.javadoc.stable
36   *
37   **************************************************************************************************************************************************************/
38  @FunctionalInterface
39  public interface StringValue
40    {
41      /***********************************************************************************************************************************************************
42       * Returns the {@link String} value of this object.
43       *
44       * @return  the string
45       **********************************************************************************************************************************************************/
46      @Nonnull
47      public String stringValue();
48    }