PropertiesActionProcessingAdvisor.java :  » Maven » maven-config-processor-plugin » com » google » code » configprocessor » processing » properties » Java Open Source

/*
 * Copyright (C) 2009 Leandro de Oliveira Aparecido <lehphyro@gmail.com>
 *
 * 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 com.google.code.configprocessor.processing.properties;

import com.google.code.configprocessor.processing.properties.model.*;

public interface PropertiesActionProcessingAdvisor {
  /**
   * Called when starting processing of a properties file.
   * 
   * @return Advice for processing.
   */
  PropertiesFileItemAdvice onStartProcessing();

  /**
   * Process a properties file item.
   * 
   * @param item Item that has been read.
   * @return Advice for processing.
   */
  PropertiesFileItemAdvice process(PropertiesFileItem item);

  /**
   * Called when processing of a properties file has been finished.
   * 
   * @return Advice for processing.
   */
  PropertiesFileItemAdvice onEndProcessing();
}