org.simpleframework.xml.core.Replace Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of simple-xml Show documentation
Show all versions of simple-xml Show documentation
Simple is a high performance XML serialization and configuration framework for Java
The newest version!
/*
* Replace.java June 2007
*
* Copyright (C) 2007, Niall Gallagher
*
* 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.simpleframework.xml.core;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Retention;
/**
* The Replace
method is used to replace an object that
* is about to be serialized to an XML document. This is used to so
* that an object can provide a substitute to itself. Scenarios such
* as serializing an object to an external file or location can be
* accommodated using a write replacement method.
*
* This is similar to the writeReplace
method used within
* Java Object Serialization in that it is used to plug a replacement
* in to the resulting stream during the serialization process. Care
* should be taken to provide a suitable type from the replacement so
* that the object can be deserialized at a later time.
*
* @author Niall Gallagher
*/
@Retention(RetentionPolicy.RUNTIME)
public @interface Replace {
}