Skip to content

Latest commit

 

History

History
166 lines (123 loc) · 3.8 KB

README.md

File metadata and controls

166 lines (123 loc) · 3.8 KB
Raw

Imladris Calendar Java Library

Download

Java library for manipulating Imladris Reckoning dates.

Package and Files

com.erutulco.utils.ImladrisCalendar is the package and class name to be used as library. src/main/java/com/erutulco/utils/ImladrisCalendar.java is the class file.

Setup

Include from jcenter() or mavenCentral() repositories. In the following, replace {version} with the version you want from the releases page without the initial v (i.e. 1.2.1-rc).

Maven

<dependency>
  <groupId>com.erutulco.utils</groupId>
  <artifactId>imladris-calendar</artifactId>
  <version>{version}</version>
  <type>pom</type>
</dependency>

Gradle

compile 'com.erutulco.utils:imladris-calendar:{version}'

Ivy

<dependency org='com.erutulco.utils' name='imladris-calendar' rev='{version}'>
  <artifact name='imladris-calendar' ext='pom' ></artifact>
</dependency>

Compilation

Clone the repository, and run the gradle command to compile the jar:

gradle jar

To compile jar files for the Sources, run the corresponding gradle commands:

gradle sourcesJar

The compiled jar file is generated in the build/libs/ folder,

Javadoc

Run the gradle command to generate the Javadoc:

gradle javadoc

Then open the generated build/docs/javadoc/index.html file in your browser.

To compile jar files for the Javadoc, run the corresponding gradle commands:

gradle javadocJar

The compiled jar file is generated in the build/libs/ folder,

Usage

Importing

Import the package into your class:

import com.erutulco.utils.ImladrisCalendar;

### Constructors

When a new instance is created, the specified date is automatically calculated. This date can be specified using the diferent constructors.

From Gregorian date/time

/*
 * Uses today's Gregorian date 
 */
ImladrisCalendar();
/*
 * Uses the date of the given GregorianCalendar object
 */
ImladrisCalendar(GregorianCalendar gregorian);
/*
 * Uses the Gregorian date given.
 * Valid values: year 1-2299 | month 1-12 | day 1-[# of days of month 'month']
 */
ImladrisCalendar(int year, int month, int dayOfMonth);
/*
 * Uses the Gregorian date and time  given.
 */
ImladrisCalendar(int year, int month, int dayOfMonth, int hourOfDay, int minute) 
/*
 * Uses the Gregorian date and time given.
 */
ImladrisCalendar(int year, int month, int dayOfMonth, int hourOfDay, int minute, int second)
With sunset

Sunset time for the specified day can also added to the above constructors at the beginning, to be taken into account in the calculation:

ImladrisCalendar(Time sunset)
ImladrisCalendar(Time sunset, GregorianCalendar gregorian)
ImladrisCalendar(Time sunset, int year, int month, int dayOfMonth);
ImladrisCalendar(Time sunset, int year, int month, int dayOfMonth, int hourOfDay, int minute)
ImladrisCalendar(Time sunset, int year, int month, int dayOfMonth, int hourOfDay, int minute, int second)

From Imladris date

/*
 * Uses Imladris date given.
 * ONLY for Yestare and Mettare.
 * Valid values: yen roman # "I"-"XVI" | loa 1-144 | period 1 OR 9
 */
ImladrisCalendar(String yen, int loa, int period);
/*
 * Uses Imladris date given.
 * Valid values: yen roman # "I"-"XVI" | loa 1-144 | period 1-9 | day 1-[# of days of period 'period']
 */
ImladrisCalendar(String yen, int loa, int period, int day);

NOTE: loar 140-144 of Yén XVI are not fully tested, and may work wrongly.