com.storedobject.common.Storable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of so-common Show documentation

SO Common utility classes

There is a newer version: 1.0.9

/*
 * Copyright 2018 Syam Pillai
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.storedobject.common;

/**
 * This interface defines a string value for anthing to store it somewhere, typically, in databases. Storable value
 * should contain all the information required to re-construct the object's instance.
 *
 * @author Syam
 */
public interface Storable {

    /**
     * Get the storable value. Bu default, {@link Object#toString()} is retuned.
     *
     * @return Storable value as a string.
     */
    default String getStorableValue() {
        return toString();
    }
}