EventsDataset (Tests 0.2.0-SNAPSHOT API)

java.lang.Object
- es.uvigo.esei.dgss.letta.domain.entities.EventsDataset

```
public final class EventsDataset
extends Object
```
Utility test class that contains a set of Event entities. This dataset is replicated in the event*.xml dataset files. Bear in mind that every Event requires an User to be set as its owner, so whenever a event*.xml dataset is included, it is required that the users.xml dataset is also present.

Author:

Jesús Álvarez Casanova, Adrián Rodríguez Fariña, Alberto Gutiérrez Jácome, Borja Cordeiro González

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`cancelledEventId()` Returns an `Event` that should exist in the database and was cancelled.
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`events()` An array of twenty-five events that should exist in the database.
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`eventsWithTwoAttendees()` An array of twenty-five events that should exist in the database, and with already attending users (two per event) to each event.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`eventWithCategory(es.uvigo.esei.dgss.letta.domain.entities.Event.Category cat)` Returns an `Event` from the `events()` array that has the provided `Event.Category`.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`eventWithId(int id)` Returns the unique `Event` from the `events()` array that has the provided ID.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`eventWithTitle(String title)` Returns an Event from the `events()` array that has the provided title.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`existentEvent()` Returns an `Event` that should exist in the database.
`static int`	`existentEventId()` Returns the ID of a `Event` that should exist in the database.
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`filterEvents(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)` Returns the `events()` that satisfy a given `Predicate`.
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`filterEventsWithTwoJoinedUsers(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)` Returns the `eventsWithTwoAttendees()` that satisfy a given `Predicate`.
`static Optional<es.uvigo.esei.dgss.letta.domain.entities.Event>`	`findEvent(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)` Returns an `Optional` holding or not the first found `Event` in `events()` that satisfies a given `Predicate`.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`findEventOrThrow(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)` Returns the first `Event` from `events()` that satisfies the given `Predicate`.
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`futureEvents()` An array of five events that should exist in the database.
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`lessThanFiveEvents()` An array of less than five events that should exist in the database.
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`lessThanTwentyEvents()` An array of less than twenty events that should exist in the database.
`static <A> List<A>`	`mapEvents(Function<es.uvigo.esei.dgss.letta.domain.entities.Event,A> f)` Transforms the `events()` array with a given `Function`, returning the resulting values in a `List`.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`newEvent()` Returns an `Event` that should not exist in the database and that may be used to create a new event.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`newEventWithoutOwner()` Returns an `Event` that should not exist in the database and that may be used to create a new event.
`static String`	`nonExistentDescription()` Returns an `Event` description that should not exist in the database.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`nonExistentEvent()`
`static int`	`nonExistentEventId()` Returns an `Event` ID that should not exist in the database.
`static String`	`nonExistentTitle()` Returns an `Event` title that should not exist in the database.
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`sortedEvents(Comparator<es.uvigo.esei.dgss.letta.domain.entities.Event> cmp)` Returns the `events()` array sorted with a given `Comparator`.
`static <C extends Comparable<C>> es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`sortedEvents(Function<es.uvigo.esei.dgss.letta.domain.entities.Event,C> f)` Returns the `events()` array sorted by a given transformation from `Event` to `Comparable`.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`updatedEvent()` Returns an `Event` that has be modified.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - futureEvents
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] futureEvents()
```
    An array of five events that should exist in the database. This data is replicated in the events.xml file.
    
    Returns:
    
    An array of five events
  - events
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] events()
```
    An array of twenty-five events that should exist in the database. This data is replicated in the events.xml file.
    
    Returns:
    
    An array of twenty-five events.
  - filterEvents
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] filterEvents(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)
```
    Returns the events() that satisfy a given Predicate.
    
    Parameters:
    
    f - The predicate that every resulting Event must satisfy.
    
    Returns:
    
    An array with the Events that satisfy the given predicate.
  - mapEvents
```
public static <A> List<A> mapEvents(Function<es.uvigo.esei.dgss.letta.domain.entities.Event,A> f)
```
    Transforms the events() array with a given Function, returning the resulting values in a List.
    
    Type Parameters:
    
    A - The type of the resulting mapping function.
    
    Parameters:
    
    f - The mapper Function from Event to any type.
    
    Returns:
    
    A List with the results of applying the given function to all the events().
  - findEvent
```
public static Optional<es.uvigo.esei.dgss.letta.domain.entities.Event> findEvent(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)
```
    Returns an Optional holding or not the first found Event in events() that satisfies a given Predicate.
    
    Parameters:
    
    f - The predicate that the resulting Event must satisfy.
    
    Returns:
    
    An optional event that satisfies the given predicate.
  - findEventOrThrow
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event findEventOrThrow(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)
```
    Returns the first Event from events() that satisfies the given Predicate.
    
    Parameters:
    
    f - The predicate that the resulting Event must satisfy.
    
    Returns:
    
    An Event that satisfies the given predicate.
    
    Throws:
    
    IllegalArgumentException - If no Event satisfies the predicate.
  - sortedEvents
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] sortedEvents(Comparator<es.uvigo.esei.dgss.letta.domain.entities.Event> cmp)
```
    Returns the events() array sorted with a given Comparator.
    
    Parameters:
    
    cmp - The Comparator to sort the Events.
    
    Returns:
    
    An array with events sorted with the given comparator.
  - sortedEvents
```
public static <C extends Comparable<C>> es.uvigo.esei.dgss.letta.domain.entities.Event[] sortedEvents(Function<es.uvigo.esei.dgss.letta.domain.entities.Event,C> f)
```
    Returns the events() array sorted by a given transformation from Event to Comparable.
    
    Type Parameters:
    
    C - The type of the Comparable by which an Event should be compared.
    
    Parameters:
    
    f - The function mapping an Event to a Comparable instance.
    
    Returns:
    
    An array with the evens sorted by the given comparable.
  - eventWithTitle
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event eventWithTitle(String title)
```
    Returns an Event from the events() array that has the provided title.
    
    Parameters:
    
    title - The title of the Event to be returned.
    
    Returns:
    
    An Event with the provided login.
    
    Throws:
    
    IllegalArgumentException - if there is no event with the provided title.
  - eventWithCategory
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event eventWithCategory(es.uvigo.esei.dgss.letta.domain.entities.Event.Category cat)
```
    Returns an Event from the events() array that has the provided Event.Category.
    
    Parameters:
    
    cat - The Event.Category of the Event to be returned.
    
    Returns:
    
    An Event with the provided category.
    
    Throws:
    
    IllegalArgumentException - If there is no event with the provided category.
  - eventWithId
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event eventWithId(int id)
```
    Returns the unique Event from the events() array that has the provided ID.
    
    Parameters:
    
    id - The id of the Event to be returned, as an integer.
    
    Returns:
    
    The unique Event with the provided ID.
    
    Throws:
    
    IllegalArgumentException - if there is no event with the provided ID.
  - lessThanFiveEvents
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] lessThanFiveEvents()
```
    An array of less than five events that should exist in the database. This data is replicated in the events-less-than-five.xml file.
    
    Returns:
    
    An array of less than five events.
  - lessThanTwentyEvents
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] lessThanTwentyEvents()
```
    An array of less than twenty events that should exist in the database. This data is replicated in the events-less-than-twenty.xml file.
    
    Returns:
    
    An array of less than twenty events.
  - existentEvent
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event existentEvent()
```
    Returns an Event that should exist in the database.
    
    Returns:
    
    An Event that should exist in the database.
  - cancelledEventId
```
public static int cancelledEventId()
```
    Returns an Event that should exist in the database and was cancelled.
    
    Returns:
    
    An Event that should exist in the database and was cancelled.
  - updatedEvent
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event updatedEvent()
```
    Returns an Event that has be modified.
    
    Returns:
    
    An Event that has be modified.
  - nonExistentEvent
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event nonExistentEvent()
```
  - existentEventId
```
public static int existentEventId()
```
    Returns the ID of a Event that should exist in the database. This is the id of the event returned by existentEvent().
    
    Returns:
    
    The id of a event that should exist in the database.
  - nonExistentEventId
```
public static int nonExistentEventId()
```
    Returns an Event ID that should not exist in the database.
    
    Returns:
    
    an event ID that should not exist in the database.
  - nonExistentTitle
```
public static String nonExistentTitle()
```
    Returns an Event title that should not exist in the database.
    
    Returns:
    
    an event title that should not exist in the database.
  - nonExistentDescription
```
public static String nonExistentDescription()
```
    Returns an Event description that should not exist in the database.
    
    Returns:
    
    an event description that should not exist in the database.
  - newEvent
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event newEvent()
```
    Returns an Event that should not exist in the database and that may be used to create a new event. This includes a User as creator, retrieved from UsersDataset.existentUser().
    
    Returns:
    
    An event that should not exist in the database.
  - newEventWithoutOwner
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event newEventWithoutOwner()
```
    Returns an Event that should not exist in the database and that may be used to create a new event. This does not include an owner, if that is required, consider using newEvent() instead.
    
    Returns:
    
    An event that should not exist in the database, with it's owner not set.
  - eventsWithTwoAttendees
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] eventsWithTwoAttendees()
```
    An array of twenty-five events that should exist in the database, and with already attending users (two per event) to each event. This data is replicated in the event-attendees.xml file.
    
    Returns:
    
    An array of twenty-five events with two users attending to each one.
  - filterEventsWithTwoJoinedUsers
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] filterEventsWithTwoJoinedUsers(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)
```
    Returns the eventsWithTwoAttendees() that satisfy a given Predicate.
    
    Parameters:
    
    f - The predicate that every resulting Event must satisfy.
    
    Returns:
    
    An array with the Events that satisfy the given predicate.

Class EventsDataset

Method Summary

Methods inherited from class java.lang.Object

Method Detail

futureEvents

events

filterEvents

mapEvents

findEvent

findEventOrThrow

sortedEvents

sortedEvents

eventWithTitle

eventWithCategory

eventWithId

lessThanFiveEvents

lessThanTwentyEvents

existentEvent

cancelledEventId

updatedEvent

nonExistentEvent

existentEventId

nonExistentEventId

nonExistentTitle

nonExistentDescription

newEvent

newEventWithoutOwner

eventsWithTwoAttendees

filterEventsWithTwoJoinedUsers