Coverage Report - org.simpleframework.xml.core.Commit
 
Classes in this File Line Coverage Branch Coverage Complexity
Commit
N/A
N/A
0
 
 1  
 /*
 2  
  * Commit.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>Commit</code> annotation is used to mark a method within
 26  
  * a serializable object that requires a callback from the persister
 27  
  * once the deserialization completes. The commit method is invoked
 28  
  * by the <code>Persister</code> after all fields have been assigned
 29  
  * and after the validation method has been invoked, if the object
 30  
  * has a method marked with the <code>Validate</code> annotation.
 31  
  * <p>
 32  
  * Typically the commit method is used to complete deserialization
 33  
  * by allowing the object to build further data structures from the
 34  
  * fields that have been created from the deserialization process.
 35  
  * The commit method must be a no argument method or a method that
 36  
  * takes a single <code>Map</code> object argument, and may throw an
 37  
  * exception, in which case the deserialization process terminates.
 38  
  * 
 39  
  * @author Niall Gallagher
 40  
  * 
 41  
  * @see org.simpleframework.xml.core.Validate
 42  
  */
 43  
 @Retention(RetentionPolicy.RUNTIME)
 44  
 public @interface Commit {
 45  
 }