Coverage Report - org.simpleframework.xml.core.Complete
 
Classes in this File Line Coverage Branch Coverage Complexity
Complete
N/A
N/A
0
 
 1  
 /*
 2  
  * Complete.java July 2006
 3  
  *
 4  
  * Copyright (C) 2006, Niall Gallagher <niallg@users.sf.net>
 5  
  *
 6  
  * Licensed under the Apache License, Version 2.0 (the "License");
 7  
  * you may not use this file except in compliance with the License.
 8  
  * You may obtain a copy of the License at
 9  
  *
 10  
  *     http://www.apache.org/licenses/LICENSE-2.0
 11  
  *
 12  
  * Unless required by applicable law or agreed to in writing, software
 13  
  * distributed under the License is distributed on an "AS IS" BASIS,
 14  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 
 15  
  * implied. See the License for the specific language governing 
 16  
  * permissions and limitations under the License.
 17  
  */
 18  
 
 19  
 package org.simpleframework.xml.core;
 20  
 
 21  
 import java.lang.annotation.RetentionPolicy;
 22  
 import java.lang.annotation.Retention;
 23  
 
 24  
 /**
 25  
  * The <code>Complete</code> annotation is used to mark a method that
 26  
  * requires a callback from the persister once the serialization of
 27  
  * the object has completed. The complete method is typically used
 28  
  * in combination with the persist method, which is the method that
 29  
  * is annotated with the <code>Persist</code> annotation.
 30  
  * <p>
 31  
  * Typically the complete method will revert any changes made when 
 32  
  * the persist method was invoked. For example, should the persist
 33  
  * method acquire a lock to ensure the object is serialized in a
 34  
  * safe state then the commit method can be used to release the lock.
 35  
  * The complete method must be a no argument public method or a
 36  
  * method that takes a single <code>Map</code> object argument. The
 37  
  * complete method is invoked even if deserialization terminates.   
 38  
  * 
 39  
  * @author Niall Gallagher
 40  
  * 
 41  
  * @see org.simpleframework.xml.core.Persist
 42  
  */
 43  
 @Retention(RetentionPolicy.RUNTIME)
 44  
 public @interface Complete {
 45  
 }