io.objectbox.converter.PropertyConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of objectbox-java-api Show documentation

ObjectBox is a fast NoSQL database for Objects

There is a newer version: 4.0.3

/*
 * Copyright 2017 ObjectBox Ltd. All rights reserved.
 *
 * 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 io.objectbox.converter;

/**
 * To use custom types in your entity, implement this to convert db values to entity values and back.
 * 
 * Notes for implementations:
 * 

 * Converters are created by the default constructor
 * Converters must be implemented thread-safe
 * Converters must not interact with the database (such as using Box or BoxStore)
 * Converters must handle null values
 * 
 */
public interface PropertyConverter {
    P convertToEntityProperty(D databaseValue);

    D convertToDatabaseValue(P entityProperty);
}