CloudantPersistentProperty.java

/*
 *
 *  * Copyright 2010-2012 the original author or authors.
 *  *
 *  * 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 org.springframework.data.cloudant.core.mapping;

import org.springframework.core.convert.converter.Converter;
import org.springframework.data.mapping.PersistentProperty;

/**
 * Created by justinsaul on 6/9/15.
 */
public interface CloudantPersistentProperty extends PersistentProperty<CloudantPersistentProperty>
{
    String getFieldName();

    @Override
    boolean isIdProperty();

    boolean isExplicitIdProperty();

    public enum PropertyToFieldNameConverter implements Converter<CloudantPersistentProperty, String> {

        INSTANCE;

        /*
         * (non-Javadoc)
         * @see org.springframework.core.convert.converter.Converter#convert(java.lang.Object)
         */
        public String convert(CloudantPersistentProperty source) {
            return source.getFieldName();
        }
    }

}