org.eclipse.persistence.sdo.helper.CodeWriter Maven / Gradle / Ivy
/*
* Copyright (c) 1998, 2021 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 v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Oracle - initial API and implementation from Oracle TopLink
package org.eclipse.persistence.sdo.helper;
/**
* Purpose:This interface can be implemented and used in conjunction with SDOClassGenerator
* to write the generated source as desired.
* @see org.eclipse.persistence.sdo.helper.SDOClassGenerator
* @see org.eclipse.persistence.sdo.helper.FileCodeWriter
*/
public interface CodeWriter {
/**
*
Called from org.eclipse.persistence.sdo.helper.SDOClassGenerator for each generated interface if a
* CodeWriter was passed into the generate method.
*
* @param dir The directory corresponding to the package of the generated source file
* @param filename The name of the generated source file including the .java extension
* @param content StringBuffer containing the contents of the generated interface.
*/
void writeInterface(String dir, String filename, StringBuffer content);
/**
*
Called from org.eclipse.persistence.sdo.helper.SDOClassGenerator for each generated interface if a
* CodeWriter was passed into the generate method.
*
* @param dir The directory corresponding to the package of the generated source file
* @param filename The name of the generated source file including the .java extension
* @param content StringBuffer containing the contents of the generated implementation class.
*/
void writeImpl(String dir, String filename, StringBuffer content);
}