# JiBX extras

JiBX Basics
Overview
Flexibility
Performance
Clean code
News and Status
Bugs
Getting Started
Binding Tutorial
A basic binding
Binding extras
Structure mapping
Collections
Using mappings
Advanced binding
Method hooks
Custom code
Binding Compiler
Binding on Load
Runtime
JiBX Extras
Building JiBX
Schema Compatibility
Mailing Lists
FAQ
Contributing
License
Binding Definition
Definition details
Definition contexts
Conversions
XML summary
<binding> element
<include> element
<format> element
<namespace> element
<mapping> element
<value> element
<structure> element
<collection> element
Attribute groups
Usage API
Runtime JavaDocs
Subprojects
Generator Tools
JibxSoap
SiteAMatic
Xsd2Jibx
Eclipse Plugin

### Introduction

JibxEclipse is a plugin for the Eclipse IDE that provides support for Java projects that use the Jibx Java<->XML binding framework.

#### Features

- A project nature which creates an association between your Eclipse project and Jibx. Adding the JiBX Nature to your project will enable:
  - JiBX configuration options for your project that determine which binding definition files to use.
  - Settings for the Jibx binding compiler (verbose output and load modified/generated class files).
- Eclipse builder which will invoke the Jibx binding compiler during clean builds only. Support for incremental builds will be added in a future release.
- Menu item with action to toggle Jibx project nature on an Eclipse project.

#### Requirements

- Java Runtime v1.4.x
- Eclipse Platform (3.0/3.0.x)

#### Known Limitations

- The binding compiler will only be invoked during a clean project build. Anytime a binding definition file (or class specified in a binding definition file) is changed you must run a clean build. Support for incremental builds will be added in a future release.

### Installation

The easiest way to install JibxEclipse is through the Eclipse Software Update Framework.

1. Define a new Update Site in Eclipse's Update Manager View
   1. Select Help->Software Updates->Find and Install...
   2. Select Find and Install...
   3. Select Search for new features to install...
   4. Select Next
   5. Select New Remote Site:
   6. Enter JibxEclipse for the name
      Enter http://jibx.sourceforge.net/jibxeclipse/site for the URL
   7. Select Ok

   Under Sites to include in search: you should see the newly create JibxEclipse update site.

2. Select the checkbox to the left of the JibxEclipse update site.
3. Select Next
4. Under Select the features to install: select the appropriate version of eclipse-jibx-feature.
5. After reading the license agreement select I agree.
6. Select Next
7. Choose the location where you would like JibxEclipse installed
8. Select Finish
9. Select Install

### Usage

Using JibxEclipse involves associating the JiBX Nature with your project, configuring the binding compiler for your project, and invoking the binding compiler.

#### Associating the JiBX Nature with your project

The first thing you must do to enable Jibx support for your project is add the JiBX Nature to your project. The easiest way to accomplish this it to right-click on the project in either the Navigator or Package Explorer view and select Add JiBX Nature. (ScreenShot)

#### Configuring the Binding Compiler

Once you've associated the JiBX Nature with your project you'll need to configure the binding compiler. To configure the binding compiler for your project right-click on your project in the Navigator or Package Explorer view and select Properties. In the Properties dialog select JiBX Preferences. Add the binding definition files for your project by selecting New and browsing your project tree for your binding definition file(s).(ScreenShot)

#### Invoking the Binding Compiler

The Jibx binding compiler will be invoked each time you perform a clean build in Eclipse (future versions will include support for incremental compilation). (ScreenShot)

Module Name | Primary Developer | Status
--- | --- | ---
jibxeclipse | Norm Deane | Beta 0.2 release January, 2005