org.eclipse.persistence.oxm.mappings.UnmarshalKeepAsElementPolicy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation

EclipseLink build based upon Git transaction 346465e

There is a newer version: 5.0.0-B05

/*******************************************************************************
 * Copyright (c) 1998, 2014 Oracle and/or its affiliates. All rights reserved.
 * This program and the accompanying materials are made available under the 
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0 
 * which accompanies this distribution. 
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at 
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *     Oracle - initial API and implementation from Oracle TopLink
 ******************************************************************************/  
package org.eclipse.persistence.oxm.mappings;
/**
 * Purpose: Used in conjunction with XMLAnyObject/CollectionMapping and XMLCompositeObject/CollectionMapping
 * to specify when (if at all) to keep parts of the unmarshalled document as nodes.
 *
 * 
 * KEEP_ALL_AS_ELEMENT Any xml matching this mapping will be brough into the object
 * model as a node.
KEEP_UNKNOWN_AS_ELEMENT Any XML with an unknown type that matches the
 * mapping in question will be a kept as an element. Those with a known type will be processed normally.
KEEP_NONE_AS_ELEMENT No xml shall be brought into the object as an element. Elements with unknown
 * types will be ignored
 * 
 */

public enum UnmarshalKeepAsElementPolicy implements org.eclipse.persistence.internal.oxm.mappings.UnmarshalKeepAsElementPolicy {

    KEEP_ALL_AS_ELEMENT, KEEP_NONE_AS_ELEMENT, KEEP_UNKNOWN_AS_ELEMENT;

    @Override
    public boolean isKeepAllAsElement() {
        return this == KEEP_ALL_AS_ELEMENT;
    }

    @Override
    public boolean isKeepNoneAsElement() {
        return this == KEEP_NONE_AS_ELEMENT;
    }

    @Override
    public boolean isKeepUnknownAsElement() {
        return this == KEEP_UNKNOWN_AS_ELEMENT;
    }

}

KEEP_ALL_AS_ELEMENT	Any xml matching this mapping will be brough into the object * model as a node.
KEEP_UNKNOWN_AS_ELEMENT	Any XML with an unknown type that matches the * mapping in question will be a kept as an element. Those with a known type will be processed normally.
KEEP_NONE_AS_ELEMENT	No xml shall be brought into the object as an element. Elements with unknown * types will be ignored