..	*******************************************************************************
	* MetaFactory.io R2
	* Technical Documentation
	* 
	* File name   : CIX_JCIE_Interface.rst
	* Created by  : Marnix Bochove (original text)
	* Updated by  : Niels de Nies
	*
	* MetaFactory BV Amsterdam 
	*******************************************************************************

.. include:: /inline-images.txt

.. include:: /metadata_include.txt



Interface
=========

<interface> is a child element of <java_package> and defines the generation of a Java Interface.

.. rubric:: Usage

The name attribute is mandatory and defines the name of the interface.

.. code-block:: xml
	:caption: <interface/> example
	:name: interface-01
	:linenos:
	:emphasize-lines: 5-20

	<code_instruction>
		...
		
		<interface>
			name="" 
			visibility="" 
			code instruction base
			
			<generic></generic>
			<apicommentline></apicommentline>
			<devcommentline></devcommentline>
			<import></import>
			<annotation></annotation>
			<inherits
			    condition="" 
			    foreach="package|object|attribute" 
			    package="">
			</inherits>
			<field></field>
			<method></method>
		</interface>

		...
	</code_instruction>

.. rubric:: Attributes


..	list-table:: **attributes of <interface/>**
	:widths: 20 80
	:header-rows: 1
	:class: tight-table

	*	-	Name
		-	Details
	*	-	name
		-	The name of the java interface that is made
	*	-	visibility
		-	Visibility of this interface. In practice this is always public
	*	-	code instruction base
		-	|Loupe S| :ref:`Code instruction base <Reference/CodeInstructionsXML/CIX_Introduction:Code instruction base>`.

.. rubric:: Sub elements

..	list-table:: **sub elements of <interface/>**
	:widths: 15 70 15
	:header-rows: 1
	:class: tight-table

	*	-	Name
		-	Details
		-	Number
	*	-	generic
		-	Makes the interface generic (java 1.5 or higher).
		-	0 or 1
	*	-	apicommentline
		-	Javadoc for this interface.
		-	0 or 1
	*	-	devcommentline
		-	Commentary that is attached to this interface.
		-	0 or 1
	*	-	import
		-	All library elements specified as 'import' are translated in the interface as import statements.
		-	0 or more
	*	-	annotation
		-	Annotation defined for the interface.
		-	0 or more
	*	-	inherits
		-	The interface from which this interface is derived.
		-	0 or more
	*	-	:ref:`field <Reference/CodeInstructionsXML/CIX_JCIE_Field:Field>`
		-	Those fields contained in this interface.
			Only static fields are added to the interface.
			When an field is non-static, only the getters and setters of this attribute are created 
			(depending on the access attribute (rw|ro|wo)). 
			This is a handy way to establish the getters and setters in an interface quickly.
		-	0 or more
	*	-	:ref:`method <Reference/CodeInstructionsXML/CIX_JCIE_Method:Method>`
		-	Methods contained in this interface.
		-	0 or more