java.lang.Object
- cz.jiripinkas.jsitemapgenerator.WebPage

All Implemented Interfaces:: Comparable<WebPage>

public class WebPage
extends Object
implements Comparable<WebPage>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class WebPage.ImageBuilder

static class WebPage.RssItemBuilder

static class WebPage.WebPageBuilder

Constructor Summary

Constructors
Constructor Description

WebPage()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`WebPage`	`addAlternateName(String language, String name)`
`WebPage`	`addImage(Image image)`
`static WebPage.WebPageBuilder`	`builder()`
`int`	`compareTo(WebPage o)`	Compare WebPage first by priority (in descending order - higher priority is first), then by shortName (in ascending order).
`String`	`constructName()`	Constructs name from dir and extension (if available), used in SitemapGenerators
`String`	`constructShortName()`	Constructs shortName from dir and extension (if available), used in RssGenerator
`boolean`	`equals(Object o)`
`Map<String,String>`	`getAlternateNames()`
`ChangeFreq`	`getChangeFreq()`
`String`	`getDir()`
`String`	`getExtension()`
`List<Image>`	`getImages()`
`Date`	`getLastMod()`
`String`	`getName()`
`Double`	`getPriority()`
`String`	`getShortDescription()`
`String`	`getShortName()`
`int`	`hashCode()`
`static WebPage.ImageBuilder`	`imageBuilder()`
`static WebPage`	`of(String name)`	Method for creating WebPage only with name (this can be useful for really simple sitemaps or with combination of default settings set on SitemapGenerator)
`static WebPage`	`of(Supplier<String> nameSupplier)`	Method for creating WebPage only with name (this can be useful for really simple sitemaps or with combination of default settings set on SitemapGenerator)
`static WebPage.RssItemBuilder`	`rssBuilder()`
`void`	`setAlternateNames(Map<String,String> alternateNames)`
`void`	`setChangeFreq(ChangeFreq changeFreq)`
`void`	`setDir(String dir)`
`void`	`setExtension(String extension)`
`void`	`setImages(List<Image> images)`
`void`	`setLastMod(Date lastMod)`
`void`	`setName(String name)`
`void`	`setPriority(Double priority)`
`void`	`setShortDescription(String shortDescription)`
`void`	`setShortName(String shortName)`

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

Constructor Detail
- WebPage
```
public WebPage()
```

Method Detail

of
```
public static WebPage of(String name)
```
Method for creating WebPage only with name (this can be useful for really simple sitemaps or with combination of default settings set on SitemapGenerator)

Parameters:

name - Name (cannot be null)

Returns:

WebPage instance

Throws:

NullPointerException - When name is null

of
```
public static WebPage of(Supplier<String> nameSupplier)
```
Method for creating WebPage only with name (this can be useful for really simple sitemaps or with combination of default settings set on SitemapGenerator)

Parameters:

nameSupplier - Name supplier (cannot return null!!!)

Returns:

WebPage instance

Throws:

NullPointerException - When nameSupplier or nameSupplier.get() returns null

addImage

public WebPage addImage(Image image)

addAlternateName

public WebPage addAlternateName(String language,
                                String name)

getImages
```
public List<Image> getImages()
```

setImages

public void setImages(List<Image> images)

getShortName
```
public String getShortName()
```

setShortName

public void setShortName(String shortName)

getShortDescription
```
public String getShortDescription()
```

setShortDescription

public void setShortDescription(String shortDescription)

setName
```
public void setName(String name)
```

setAlternateNames

public void setAlternateNames(Map<String,String> alternateNames)

setLastMod

public void setLastMod(Date lastMod)

setChangeFreq

public void setChangeFreq(ChangeFreq changeFreq)

setPriority

public void setPriority(Double priority)

constructName
```
public String constructName()
```
Constructs name from dir and extension (if available), used in SitemapGenerators

Returns:

Name

constructShortName
```
public String constructShortName()
```
Constructs shortName from dir and extension (if available), used in RssGenerator

Returns:

Name

getName
```
public String getName()
```

getAlternateNames

public Map<String,String> getAlternateNames()

getLastMod
```
public Date getLastMod()
```

getChangeFreq
```
public ChangeFreq getChangeFreq()
```

getPriority
```
public Double getPriority()
```

getDir
```
public String getDir()
```

setDir
```
public void setDir(String dir)
```

getExtension
```
public String getExtension()
```

setExtension

public void setExtension(String extension)

compareTo
```
public int compareTo(WebPage o)
```
Compare WebPage first by priority (in descending order - higher priority is first), then by shortName (in ascending order). Priority and / or shortName can be null. WebPages with null priority are at the end.

Specified by:

compareTo in interface Comparable<WebPage>

Parameters:

o - Other WebPage

Returns:

-1, 0, 1

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

builder

public static WebPage.WebPageBuilder builder()

rssBuilder

public static WebPage.RssItemBuilder rssBuilder()

imageBuilder

public static WebPage.ImageBuilder imageBuilder()

Modifier and Type	Class	Description
`static class`	`WebPage.ImageBuilder`
`static class`	`WebPage.RssItemBuilder`
`static class`	`WebPage.WebPageBuilder`

Class WebPage

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebPage

Method Detail

of

of

addImage

addAlternateName

getImages

setImages

getShortName

setShortName

getShortDescription

setShortDescription

setName

setAlternateNames

setLastMod

setChangeFreq

setPriority

constructName

constructShortName

getName

getAlternateNames

getLastMod

getChangeFreq

getPriority

getDir

setDir

getExtension

setExtension

compareTo

equals

hashCode

builder

rssBuilder

imageBuilder