io.twipple.springframework.data.clusterpoint.mapping.ClusterpointPersistentProperty.java Source code

Introduction

Here is the source code for io.twipple.springframework.data.clusterpoint.mapping.ClusterpointPersistentProperty.java

Source

/*
 * This file is part of Spring Data Clusterpoint.
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 the author or authors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package io.twipple.springframework.data.clusterpoint.mapping;

import org.springframework.data.mapping.PersistentProperty;

/**
 * Represents a property part of an entity that needs to be persisted.
 *
 * @author Olegs Briska
 */
public interface ClusterpointPersistentProperty
        extends PersistentProperty<ClusterpointPersistentProperty>, HasQualifiedName {

    /**
     * Get the flag indicating whether the property has to be persisted as an XML element.
     * This flag is the opposite of the flag returned by {@link #isXmlAttribute()} except for a transient property,
     * in which case both {@link #isXmlElement()} and {@link #isXmlAttribute()} return false.
     *
     * @return {@literal true}, if the property has to be persisted as an XML element, or {@literal false} otherwise.
     * @see #isXmlAttribute()
     */
    boolean isXmlElement();

    /**
     * Get the flag indicating whether the property has to be persisted as an XML attribute.
     * This flag is the opposite of the flag returned by {@link #isXmlElement()} except for a transient property,
     * in which case both {@link #isXmlElement()} and {@link #isXmlAttribute()} return false.
     *
     * @return {@literal true}, if the property has to be persisted as an XML attribute, or {@literal false} otherwise.
     * @see #isXmlElement()
     */
    boolean isXmlAttribute();
}