Draft (wflib-java 0.9.0 API)

java.lang.Object
- net.wildfyre.descriptors.Descriptor
- - net.wildfyre.posts.Draft

```
public class Draft
extends Descriptor
```
This class represents a Draft, which is essentially a builder for a Post. Drafts can be saved server-side before they are converted to a Post, using publish(). They can be saved server-side using save(). Drafts will not attempt to synchronize themselves, it is the responsibility of the user to either save or publish them, each time they are modified.

Constructor Summary

Constructors
Constructor and Description

Draft(long draftID, String areaID)
Creates a new Draft that points to a server-side Draft.

Draft(String areaID)
Creates a new local Draft.

Constructors
Constructor and Description
`Draft(long draftID, String areaID)` Creates a new Draft that points to a server-side Draft.
`Draft(String areaID)` Creates a new local Draft.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`net.wildfyre.areas.Area`	`area()` The area in which is post was published.
`Optional<User>`	`author()` The author of this post.
`CacheManager`	`cacheManager()` The Cache Manager that handles this object.
`Stream<Comment>`	`comments()` The comments on this post.
`List<Comment>`	`commentsList()` The comments on this post, as a List.
`ZonedDateTime`	`created()` The date and time at which this post was created, in the UTC timezone.
`ZonedDateTime`	`createdLocalTime()` The date and time at which this post was created, in the local timezone.
`void`	`delete()` Deletes this object, from both the server and the cache.
`boolean`	`equals(Object o)`
`static CacheManager`	`getCacheManager()` The cache manager that handles the Drafts.
`int`	`hashCode()`
`boolean`	`hasSubscribed()` Is the logged-in user subscribed to this post?
`long`	`ID()` The ID of this post.
`boolean`	`isActive()` Is this post active?
`boolean`	`isAnonymous()` Is this post anonymous?
`boolean`	`isAuthorDeleted()` Was the author of this post deleted?
`Post`	`publish()` Converts this Draft to a Post and publishes it.
`Draft`	`save()` Saves this Draft server-side.
`Draft`	`setIsAnonymous(boolean isAnonymous)` Make this object anonymous or not anonymous.
`Draft`	`setText(String newText)` Sets the text of this object.
`Draft`	`subscribe()` Subscribes the logged-in user to this post.
`String`	`text()` The text of this post, in MarkDown.
`protected com.eclipsesource.json.JsonObject`	`toJsonSimple()` Generates the JSON String needed by the server to understand this object.
`String`	`toString()`
`Draft`	`unsubscribe()` Unsubscribes the logged-in user from this post.
`void`	`update()` Updates this Descriptor.

Methods inherited from class net.wildfyre.descriptors.Descriptor
isNew, isValid, isValid, use

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

- Constructor Detail
  - Draft
```
public Draft(String areaID)
```
    Creates a new local Draft.
    The method Area.draft() is essentially the same as this constructor.
    
    Parameters:
    
    areaID - the area it will be in.
  - Draft
```
public Draft(long draftID,
             String areaID)
```
    Creates a new Draft that points to a server-side Draft.
    This method is for advanced-users only. If you want to create a Draft, use Draft(String) or Area.draft().
    
    Parameters:
    
    draftID - the ID of the draft
    
    areaID - the ID of the area the draft is in
- Method Detail
  - publish
```
public Post publish()
```
    Converts this Draft to a Post and publishes it. This Draft does not need to have been previously saved using save().
    This method will perform the API calls in the current thread.
    
    Returns:
    
    The Post resulting from the publishing of this Draft.
  - save
```
public Draft save()
```
    Saves this Draft server-side.
    This method will perform the API calls in the current thread.
    
    Returns:
    
    This object itself, to allow method-chaining.
  - delete
```
public void delete()
```
    Deletes this object, from both the server and the cache.
  - cacheManager
```
public CacheManager cacheManager()
```
    Description copied from class: Descriptor
    
    The Cache Manager that handles this object.
    
    Specified by:
    
    cacheManager in class Descriptor
    
    Returns:
    
    This object.
  - getCacheManager
```
public static CacheManager getCacheManager()
```
    The cache manager that handles the Drafts.
    
    Returns:
    
    The Draft Cache Manager.
  - update
```
public void update()
```
    Description copied from class: Descriptor
    
    Updates this Descriptor.
    The update is always executed in the current thread.
    
    Specified by:
    
    update in class Descriptor
  - setIsAnonymous
```
public Draft setIsAnonymous(boolean isAnonymous)
```
    Make this object anonymous or not anonymous.
    
    Parameters:
    
    isAnonymous - true to make this object anonymous, false to make it not-anonymous.
    
    Returns:
    
    This object itself, to allow method-chaining.
  - subscribe
```
public Draft subscribe()
```
    Subscribes the logged-in user to this post.
    
    Returns:
    
    This object itself, to allow method-chaining.
  - unsubscribe
```
public Draft unsubscribe()
```
    Unsubscribes the logged-in user from this post.
    
    Returns:
    
    This object itself, to allow method-chaining.
  - setText
```
public Draft setText(String newText)
```
    Sets the text of this object.
    
    Parameters:
    
    newText - the new text of this object.
    
    Returns:
    
    This object itself, to allow method-chaining.
  - isAnonymous
```
public boolean isAnonymous()
```
    Is this post anonymous?
    Note that in the case where a not-anonymous post's author is deleted, the post is still not anonymous, but doesn't have an author either.
    
    Returns:
    
    true if the post is anonymous.
    
    See Also:
    
    Get the author of this message., Was the author of this post deleted?
  - hasSubscribed
```
public boolean hasSubscribed()
```
    Is the logged-in user subscribed to this post?
    
    Returns:
    
    true if the logged-in user subscribed to this post.
  - isAuthorDeleted
```
public boolean isAuthorDeleted()
```
    Was the author of this post deleted?
    This method is a simple helper rather than a getter for some server-provided data. It is a shortcut for:
```
 !author().isPresent() && !isAnonymous();
```
    Returns:
    
    true if the author of this post was deleted.
    
    See Also:
    
    Is this post anonymous?, The author of this post.
  - created
```
public ZonedDateTime created()
```
    The date and time at which this post was created, in the UTC timezone.
    
    Returns:
    
    The date and time at which this post was created.
    
    See Also:
    
    In the local timezone
  - createdLocalTime
```
public ZonedDateTime createdLocalTime()
```
    The date and time at which this post was created, in the local timezone. The local timezone is acquired using ZoneId.systemDefault(), if you are searching for an other timezone, use created() and ZonedDateTime.withZoneSameInstant(ZoneId).
    
    Returns:
    
    The date and time at which this post was created.
    
    See Also:
    
    In the UTC timezone
  - isActive
```
public boolean isActive()
```
    Is this post active?
    An active post is a post that continues to spread to new users.
    
    Returns:
    
    true if this post is active.
  - text
```
public String text()
```
    The text of this post, in MarkDown.
    
    Returns:
    
    The text of this post.
  - author
```
public Optional<User> author()
```
    The author of this post.
    There are two cases where there may not be an author: the author chose this post post to be anonymous, or the original author was deleted since this post's creation.
    
    Returns:
    
    The author of this post, if any.
    
    See Also:
    
    Is this post anonymous?, Was the author of this post deleted?
  - area
```
public net.wildfyre.areas.Area area()
```
    The area in which is post was published.
    
    Returns:
    
    The area in which the post was published.
  - ID
```
public long ID()
```
    The ID of this post.
    This API is crafted so that the end-user doesn't need to use IDs. This method is provided for the rare case where you need the ID for customized handling of the cache.
    
    Returns:
    
    The ID of this post.
  - commentsList
```
public List<Comment> commentsList()
```
    The comments on this post, as a List.
    The returned list is read-only and provided by Collections.unmodifiableList(List).
    
    Returns:
    
    A read-only list of the comments in this post.
    
    See Also:
    
    We recommend using Streams
  - comments
```
public Stream<Comment> comments()
```
    The comments on this post.
    
    Returns:
    
    The comments on this post.
    
    See Also:
    
    Get the comments in a List.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toJsonSimple
```
protected final com.eclipsesource.json.JsonObject toJsonSimple()
```
    Generates the JSON String needed by the server to understand this object. Some elements are excluded:
    - The ID of this object
    - The comments
    - The author
    - The activity of this post (active or not)
    Returns:
    
    This object, written in JSON.

Class Draft

Constructor Summary

Method Summary

Methods inherited from class net.wildfyre.descriptors.Descriptor

Methods inherited from class java.lang.Object

Constructor Detail

Draft

Draft

Method Detail

publish

save

delete

cacheManager

getCacheManager

update

setIsAnonymous

subscribe

unsubscribe

setText

isAnonymous

hasSubscribed

isAuthorDeleted

created

createdLocalTime

isActive

text

author

area

ID

commentsList

comments

equals

hashCode

toString

toJsonSimple