# eclipse-collections-kata

**Repository Path**: wangrangzhi/eclipse-collections-kata

## Basic Information

- **Project Name**: eclipse-collections-kata
- **Description**: Collections Kata
- **Primary Language**: Java
- **License**: EPL-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-12-02
- **Last Updated**: 2024-08-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![logo](./docs/shared/eclipse-collections-logo.png)

Eclipse Collections Kata 
========================
A [kata](https://en.wikipedia.org/wiki/Kata) is an exercise in martial arts. 
A [code kata](http://codekata.com/) is an exercise in programming which helps hone your skills through practice and repetition. 
The Eclipse Collections Kata is a fun way to help you learn idiomatic Eclipse Collections usage. 
This particular kata is set up as a series of unit tests which fail. 
Your task is to make them pass, using Eclipse Collections.

Initialize Kata
---------------
Clone this repo or simply download and extract the master [zip file](https://github.com/eclipse/eclipse-collections-kata/archive/master.zip), 
then follow the instructions below for your IDE/platform. 


### Eclipse users

Initialize Eclipse project with the command below. 

##### Mac/Linux/Unix:
```
./gradlew eclipse
```

##### Windows:
```
gradlew.bat eclipse
```
Once the project is initialized, 
you can import the project from "Import" => "General" => "Existing Projects into Workspace". 
Select "eclipse-collections-kata" directory as root directory, 
make sure to choose "Search for nested projects" option and finish.
### IntelliJ IDEA users

Initialize IntelliJ IDEA project with the command below. 

##### Mac/Linux/Unix:
```
./gradlew idea
```

##### Windows:
```
gradlew.bat idea
```

Once the project is initialized, 
you can open the project from "File" => "Open..." => choose "eclipse-collections-kata" folder. 
You might see a dialog to suggest importing Gradle project, it's up to you to do so if you'd like to invoke gradle builds from IDEA.
Kata can run in IDEA even if you don't import Gradle project.

### NetBeans users

##### Linux/Mac/Windows:

_open as a Maven project_

You can open the project directly from "File" => "Open Project..." => choose "eclipse-collections-kata" folder.
In the "Open Project" dialog you might select the option "Open Required Projects" to automatically open the two modules.

_open as a Gradle project_

The "Gradle Support" plugin needs already to be installed.<br>
Temporarily remove/rename the `pom.xml` file. Then open the project from "File" => "Open Project..." => choose "eclipse-collections-kata" folder.<br>
Restore the `pom.xml` file.

Work on Kata exercises
----------------------
There are two separate katas under different directories (Company Kata and Pet Kata).

```
company-kata/src/tests
pet-kata/src/tests
```

To get started, you can refer to slides for the [Instruction and Pet Kata](http://eclipse.github.io/eclipse-collections-kata/) to learn how to set-up Kata, basic features of Eclipse Collections corresponding to each Pet Kata exercise and then solutions. 

To learn wider range of functionalities, slides for [Company Kata](http://eclipse.github.io/eclipse-collections-kata/company-kata) are now available online as well. 

Check out the [solution branch](https://github.com/eclipse/eclipse-collections-kata/tree/solutions) for your reference.

Enjoy happy learning with Eclipse Collections Kata!


Reference Guide
---------------
The [Eclipse Collections Reference Guide](https://github.com/eclipse/eclipse-collections/blob/master/docs/guide.md) is a great way to get an overview of the extensive features available in the framework.


Presentations
-------------
The [API Design of Eclipse Collections](http://eclipse.github.io/eclipse-collections-kata/api-design) covers the design 
decisions that went into making Eclipse Collections and guiding its evolution from Java 4 through Java 9. 
The content of the presentation is also available in a convenient to read [markdown format](https://github.com/eclipse/eclipse-collections-kata/blob/master/docs/api-design/slides.md).