A B C D E F G H I L M O P R S T V X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AddClassAttributeToFirstHeaderRule - Class in org.codehaus.xsite.extractors.sitemesh.rules
-
Rule for HTMLProcessor that adds a class attribute to the first header of the body if it is the first element.
- AddClassAttributeToFirstHeaderRule() - Constructor for class org.codehaus.xsite.extractors.sitemesh.rules.AddClassAttributeToFirstHeaderRule
- AddClassAttributeToFirstHeaderRule(String) - Constructor for class org.codehaus.xsite.extractors.sitemesh.rules.AddClassAttributeToFirstHeaderRule
- AddFirstChildClassToHeader - Class in org.codehaus.xsite.extractors.sitemesh.rules
-
Deprecated.
- AddFirstChildClassToHeader() - Constructor for class org.codehaus.xsite.extractors.sitemesh.rules.AddFirstChildClassToHeader
-
Deprecated.
- addPage(Page) - Method in class org.codehaus.xsite.model.Section
- addProperty(String, String) - Method in class org.codehaus.xsite.extractors.AttributedPageBuilder
- addSection(Section) - Method in class org.codehaus.xsite.model.Sitemap
- AttributedPageBuilder - Class in org.codehaus.xsite.extractors
-
A PageBuilder that supports custom attributes and can be used for DI.
- AttributedPageBuilder(CharacterEscaper) - Constructor for class org.codehaus.xsite.extractors.AttributedPageBuilder
B
- badLink(Page, String) - Method in interface org.codehaus.xsite.validators.LinkChecker.Reporter
- build(File, File, File[], File, Map<String, Object>) - Method in class org.codehaus.xsite.XSite
C
- CannotApplySkinException(Throwable) - Constructor for exception org.codehaus.xsite.skins.FreemarkerSkin.CannotApplySkinException
- CannotCreateSkinException(Throwable) - Constructor for exception org.codehaus.xsite.skins.FreemarkerSkin.CannotCreateSkinException
- CannotParsePageException(Throwable) - Constructor for exception org.codehaus.xsite.extractors.SiteMeshPageExtractor.CannotParsePageException
- CharacterEscaper - Class in org.codehaus.xsite.extractors
-
Allows the escaping of characters with HTML entities.
- CharacterEscaper() - Constructor for class org.codehaus.xsite.extractors.CharacterEscaper
- CharacterEscaper(Map<String, String>) - Constructor for class org.codehaus.xsite.extractors.CharacterEscaper
- CommonsFileSystem - Class in org.codehaus.xsite.io
-
Commons-based FileSystem implementation
- CommonsFileSystem() - Constructor for class org.codehaus.xsite.io.CommonsFileSystem
- CommonsFileSystem.FileSystemException - Exception in org.codehaus.xsite.io
- copyDirectory(File, File, boolean) - Method in interface org.codehaus.xsite.FileSystem
- copyDirectory(File, File, boolean) - Method in class org.codehaus.xsite.io.CommonsFileSystem
- copyFile(File, File) - Method in interface org.codehaus.xsite.FileSystem
- copyFile(File, File) - Method in class org.codehaus.xsite.io.CommonsFileSystem
- createXSite(Map<?, ?>) - Method in class org.codehaus.xsite.factories.DefaultXSiteFactory
- createXSite(Map<?, ?>) - Method in class org.codehaus.xsite.factories.PicoXSiteFactory
- createXSite(Map<?, ?>) - Method in interface org.codehaus.xsite.XSiteFactory
-
Creates an XSite instance
D
- defaultEscapedCharacters() - Static method in class org.codehaus.xsite.extractors.CharacterEscaper
-
Returns the escaped characters from ordinal number range 192-255
- DefaultXSiteFactory - Class in org.codehaus.xsite.factories
-
Implementation of XSiteFactory which returns instances of XSite with default dependencies
- DefaultXSiteFactory() - Constructor for class org.codehaus.xsite.factories.DefaultXSiteFactory
- DropDivOfClassSectionRule - Class in org.codehaus.xsite.extractors.sitemesh.rules
-
Special rule for Maven/Doxia generated HTML pages.
- DropDivOfClassSectionRule() - Constructor for class org.codehaus.xsite.extractors.sitemesh.rules.DropDivOfClassSectionRule
E
- end(Tag) - Method in class org.codehaus.xsite.extractors.sitemesh.rules.H1ToTitleRule
- Entry - Class in org.codehaus.xsite.model
-
Represents a generic entry in sitemap
- Entry() - Constructor for class org.codehaus.xsite.model.Entry
- escape(String) - Method in class org.codehaus.xsite.extractors.CharacterEscaper
- escapedCharacters(int, int) - Static method in class org.codehaus.xsite.extractors.CharacterEscaper
-
Returns the escaped characters from ordinal number range provided
- extractPage(File) - Method in class org.codehaus.xsite.extractors.SiteMeshPageExtractor
- extractPage(File) - Method in interface org.codehaus.xsite.PageExtractor
- extractPage(String, String) - Method in class org.codehaus.xsite.extractors.SiteMeshPageExtractor
- extractPage(String, String) - Method in interface org.codehaus.xsite.PageExtractor
F
- FileSystem - Interface in org.codehaus.xsite
-
Handles filesystem operations
- FileSystemException(String, Throwable) - Constructor for exception org.codehaus.xsite.io.CommonsFileSystem.FileSystemException
- filter(String) - Method in class org.codehaus.xsite.extractors.sitemesh.filters.MailToLinkTextFilter
- FreemarkerSkin - Class in org.codehaus.xsite.skins
-
Provides HTML 'skin' around content, using a FreeMarker template.
- FreemarkerSkin() - Constructor for class org.codehaus.xsite.skins.FreemarkerSkin
- FreemarkerSkin.CannotApplySkinException - Exception in org.codehaus.xsite.skins
- FreemarkerSkin.CannotCreateSkinException - Exception in org.codehaus.xsite.skins
G
- getAllEntries() - Method in class org.codehaus.xsite.model.Sitemap
- getAllPages() - Method in class org.codehaus.xsite.model.Sitemap
- getBody() - Method in class org.codehaus.xsite.model.Page
- getEntries() - Method in class org.codehaus.xsite.model.Section
- getFileFilter() - Method in class org.codehaus.xsite.io.CommonsFileSystem
-
Specifies the file filter used in the #copyDirectory() method.
- getFilename() - Method in class org.codehaus.xsite.model.Page
- getHead() - Method in class org.codehaus.xsite.model.Page
- getHref() - Method in class org.codehaus.xsite.model.Link
- getHref() - Method in class org.codehaus.xsite.model.Page
- getId() - Method in class org.codehaus.xsite.model.Page
- getLinks() - Method in class org.codehaus.xsite.model.Page
- getName() - Method in class org.codehaus.xsite.model.Parameter
- getName() - Method in class org.codehaus.xsite.model.Section
- getPages() - Method in class org.codehaus.xsite.model.Section
- getParagraphs() - Method in class org.codehaus.xsite.model.Page
- getParameter() - Method in class org.codehaus.xsite.model.Sitemap
- getProperties() - Method in class org.codehaus.xsite.extractors.AttributedPageBuilder
- getProperties() - Method in class org.codehaus.xsite.model.Page
- getSections() - Method in class org.codehaus.xsite.model.Sitemap
- getTitle() - Method in class org.codehaus.xsite.model.Link
- getTitle() - Method in class org.codehaus.xsite.model.Page
- getValue() - Method in class org.codehaus.xsite.model.Parameter
H
- H1ToTitleRule - Class in org.codehaus.xsite.extractors.sitemesh.rules
-
Treat the content of the first H1 tag as page title and drop the element instead.
- H1ToTitleRule(PageBuilder) - Constructor for class org.codehaus.xsite.extractors.sitemesh.rules.H1ToTitleRule
I
- ImgAttributesRule - Class in org.codehaus.xsite.extractors.sitemesh.rules
-
Convert attributes appended to the image src into real attributes.
- ImgAttributesRule() - Constructor for class org.codehaus.xsite.extractors.sitemesh.rules.ImgAttributesRule
- isIndex() - Method in class org.codehaus.xsite.model.Page
- isValid(String) - Method in interface org.codehaus.xsite.LinkValidator
-
Test the argument for a valid link
- isValid(String) - Method in class org.codehaus.xsite.validators.StartsWithLinkValidator
L
- Link - Class in org.codehaus.xsite.model
-
Represents a link entry in a sitemap, including title and href.
- Link(String, String) - Constructor for class org.codehaus.xsite.model.Link
- LinkChecker - Class in org.codehaus.xsite.validators
-
Verifies all the links in a Sitemap.
- LinkChecker(Sitemap, LinkValidator[], LinkChecker.Reporter) - Constructor for class org.codehaus.xsite.validators.LinkChecker
- LinkChecker.Reporter - Interface in org.codehaus.xsite.validators
-
Callback for errors.
- LinkValidator - Interface in org.codehaus.xsite
-
Interface for link validators.
- load(File) - Method in interface org.codehaus.xsite.Skin
- load(File) - Method in class org.codehaus.xsite.skins.FreemarkerSkin
- loadFrom(File) - Method in class org.codehaus.xsite.loaders.XStreamSitemapLoader
- loadFrom(File) - Method in interface org.codehaus.xsite.SitemapLoader
M
- MailToLinkTextFilter - Class in org.codehaus.xsite.extractors.sitemesh.filters
-
A text filter to inject a mailto: URL.
- MailToLinkTextFilter(Map<String, String>) - Constructor for class org.codehaus.xsite.extractors.sitemesh.filters.MailToLinkTextFilter
- MailToLinkTextFilter(Map<String, String>, String) - Constructor for class org.codehaus.xsite.extractors.sitemesh.filters.MailToLinkTextFilter
- main(String[]) - Static method in class org.codehaus.xsite.Main
- Main - Class in org.codehaus.xsite
-
Command line entry point for building XSite.
- Main(String[]) - Constructor for class org.codehaus.xsite.Main
O
- org.codehaus.xsite - package org.codehaus.xsite
- org.codehaus.xsite.extractors - package org.codehaus.xsite.extractors
- org.codehaus.xsite.extractors.sitemesh.filters - package org.codehaus.xsite.extractors.sitemesh.filters
- org.codehaus.xsite.extractors.sitemesh.rules - package org.codehaus.xsite.extractors.sitemesh.rules
- org.codehaus.xsite.factories - package org.codehaus.xsite.factories
- org.codehaus.xsite.io - package org.codehaus.xsite.io
- org.codehaus.xsite.loaders - package org.codehaus.xsite.loaders
- org.codehaus.xsite.model - package org.codehaus.xsite.model
- org.codehaus.xsite.skins - package org.codehaus.xsite.skins
- org.codehaus.xsite.validators - package org.codehaus.xsite.validators
P
- Page - Class in org.codehaus.xsite.model
-
Represents a single page entry in a sitemap, including filename, head and body.
- Page(String, String, String, Collection<Link>, Map<String, String>) - Constructor for class org.codehaus.xsite.model.Page
-
Creates a Page
- PageExtractor - Interface in org.codehaus.xsite
-
Extracts Page content from HTML files
- Parameter - Class in org.codehaus.xsite.model
-
A parameter for the web site.
- Parameter(String, String) - Constructor for class org.codehaus.xsite.model.Parameter
- PicoXSiteFactory - Class in org.codehaus.xsite.factories
-
NanoContainer-based implementation of XSiteFactory
- PicoXSiteFactory() - Constructor for class org.codehaus.xsite.factories.PicoXSiteFactory
- process(Tag) - Method in class org.codehaus.xsite.extractors.sitemesh.rules.AddClassAttributeToFirstHeaderRule
- process(Tag) - Method in class org.codehaus.xsite.extractors.sitemesh.rules.DropDivOfClassSectionRule
- process(Tag) - Method in class org.codehaus.xsite.extractors.sitemesh.rules.ImgAttributesRule
- process(Tag) - Method in class org.codehaus.xsite.extractors.sitemesh.rules.TopLevelBlockExtractingRule
R
- readFile(File) - Method in interface org.codehaus.xsite.FileSystem
- readFile(File) - Method in class org.codehaus.xsite.io.CommonsFileSystem
S
- Section - Class in org.codehaus.xsite.model
-
A section in a website holding entries, which can be either pages or links.
- Section(String) - Constructor for class org.codehaus.xsite.model.Section
- setValue(String) - Method in class org.codehaus.xsite.model.Parameter
- Sitemap - Class in org.codehaus.xsite.model
-
Holds the structure of a website.
- Sitemap() - Constructor for class org.codehaus.xsite.model.Sitemap
- SitemapLoader - Interface in org.codehaus.xsite
-
Loads site map content from a configuration file.
- SiteMeshPageExtractor - Class in org.codehaus.xsite.extractors
-
PageExtractor which extract page information from an HTML file using the SiteMesh library.
- SiteMeshPageExtractor() - Constructor for class org.codehaus.xsite.extractors.SiteMeshPageExtractor
- SiteMeshPageExtractor(TagRule[], TextFilter[], FileSystem) - Constructor for class org.codehaus.xsite.extractors.SiteMeshPageExtractor
- SiteMeshPageExtractor(TagRule[], TextFilter[], FileSystem, CharacterEscaper) - Constructor for class org.codehaus.xsite.extractors.SiteMeshPageExtractor
- SiteMeshPageExtractor(TagRule[], TextFilter[], FileSystem, CharacterEscaper, AttributedPageBuilder) - Constructor for class org.codehaus.xsite.extractors.SiteMeshPageExtractor
- SiteMeshPageExtractor(TagRule[], FileSystem) - Constructor for class org.codehaus.xsite.extractors.SiteMeshPageExtractor
- SiteMeshPageExtractor(TagRule[], FileSystem, CharacterEscaper) - Constructor for class org.codehaus.xsite.extractors.SiteMeshPageExtractor
- SiteMeshPageExtractor(TagRule[], FileSystem, CharacterEscaper, AttributedPageBuilder) - Constructor for class org.codehaus.xsite.extractors.SiteMeshPageExtractor
- SiteMeshPageExtractor(TextFilter[], FileSystem) - Constructor for class org.codehaus.xsite.extractors.SiteMeshPageExtractor
- SiteMeshPageExtractor(TextFilter[], FileSystem, CharacterEscaper) - Constructor for class org.codehaus.xsite.extractors.SiteMeshPageExtractor
- SiteMeshPageExtractor(TextFilter[], FileSystem, CharacterEscaper, AttributedPageBuilder) - Constructor for class org.codehaus.xsite.extractors.SiteMeshPageExtractor
- SiteMeshPageExtractor.CannotParsePageException - Exception in org.codehaus.xsite.extractors
- skin(Page, Sitemap, File, Map<String, Object>) - Method in interface org.codehaus.xsite.Skin
- skin(Page, Sitemap, File, Map<String, Object>) - Method in class org.codehaus.xsite.skins.FreemarkerSkin
- Skin - Interface in org.codehaus.xsite
-
Represents a skin, i.e.
- StartsWithLinkValidator - Class in org.codehaus.xsite.validators
-
Validate a link starting with a special value.
- StartsWithLinkValidator(String) - Constructor for class org.codehaus.xsite.validators.StartsWithLinkValidator
T
- TopLevelBlockExtractingRule - Class in org.codehaus.xsite.extractors.sitemesh.rules
-
Rule to extract all top level block elements as separate paragraphs.
- TopLevelBlockExtractingRule(PageBuilder) - Constructor for class org.codehaus.xsite.extractors.sitemesh.rules.TopLevelBlockExtractingRule
V
- validateLinks() - Method in class org.codehaus.xsite.XSiteConfiguration
- verify() - Method in class org.codehaus.xsite.validators.LinkChecker
-
Verifies all the links in the site.
- verifyLinkHref(String) - Method in class org.codehaus.xsite.validators.LinkChecker
X
- XSite - Class in org.codehaus.xsite
-
Facade for building sites
- XSite(SitemapLoader, Skin, LinkValidator[], FileSystem, XSiteConfiguration) - Constructor for class org.codehaus.xsite.XSite
-
Creates an XSite
- XSiteConfiguration - Class in org.codehaus.xsite
-
Holds configuration of XSite
- XSiteConfiguration() - Constructor for class org.codehaus.xsite.XSiteConfiguration
- XSiteConfiguration(boolean) - Constructor for class org.codehaus.xsite.XSiteConfiguration
- XSiteFactory - Interface in org.codehaus.xsite
-
XSiteFactory creates XSite instances
- XStreamSitemapLoader - Class in org.codehaus.xsite.loaders
-
Loads a Sitemap from an XML file using XStream.
- XStreamSitemapLoader(PageExtractor, XStream) - Constructor for class org.codehaus.xsite.loaders.XStreamSitemapLoader
-
Creates a XStreamSitemapLoader
All Classes All Packages