Post (wflib-java 0.9.0 API)

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

```
public class Post
extends Descriptor
```
Posts are the main objects in WildFyre.
You cannot create a Post directly, as they cannot be modified. To post something, first create a Draft then use its Draft.publish() method to convert it to a Post.

Constructor Summary

Constructors
Constructor and Description

Post(long ID, String areaID)
Creates an empty Post object pointing to a Post on the server-side.

Constructors
Constructor and Description
`Post(long ID, String areaID)` Creates an empty Post object pointing to a Post on the server-side.

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.
`boolean`	`equals(Object o)`
`static CacheManager`	`getCacheManager()` The cache manager used by Posts.
`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?
`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()`
`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
  - Post
```
public Post(long ID,
            String areaID)
```
    Creates an empty Post object pointing to a Post on the server-side.
    Note that this method is provided for advanced users. If you want to create a new Post, you should first create a Draft, edit it, then convert it to a Post. More information can be found here.
    
    Parameters:
    
    ID - the ID of the post
    
    areaID - the ID of the area the post is in
- Method Detail
  - 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 used by Posts.
    
    Returns:
    
    The cache manager used by Posts.
  - update
```
public void update()
            throws NoSuchEntityException,
                   net.wildfyre.http.Request.CantConnectException
```
    Description copied from class: Descriptor
    
    Updates this Descriptor.
    The update is always executed in the current thread.
    
    Specified by:
    
    update in class Descriptor
    
    Throws:
    
    NoSuchEntityException
    
    net.wildfyre.http.Request.CantConnectException
  - 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 Post

Constructor Summary

Method Summary

Methods inherited from class net.wildfyre.descriptors.Descriptor

Methods inherited from class java.lang.Object

Constructor Detail

Post

Method Detail

cacheManager

getCacheManager

update

isAnonymous

hasSubscribed

isAuthorDeleted

created

createdLocalTime

isActive

text

author

area

ID

commentsList

comments

equals

hashCode

toString

toJsonSimple