You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2023/01/29 17:32:25 UTC
[maven-doxia-sitetools] branch DOXIASITETOOLS-285 created (now 0e4b2e2)
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a change to branch DOXIASITETOOLS-285
in repository https://gitbox.apache.org/repos/asf/maven-doxia-sitetools.git
at 0e4b2e2 [DOXIASITETOOLS-285] Deprecate SiteRenderingContext#defaultWindowTitle in favor of SiteRenderingContext#defaultTitle
This branch includes the following new commits:
new 0e4b2e2 [DOXIASITETOOLS-285] Deprecate SiteRenderingContext#defaultWindowTitle in favor of SiteRenderingContext#defaultTitle
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[maven-doxia-sitetools] 01/01: [DOXIASITETOOLS-285] Deprecate SiteRenderingContext#defaultWindowTitle in favor of SiteRenderingContext#defaultTitle
Posted by mi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch DOXIASITETOOLS-285
in repository https://gitbox.apache.org/repos/asf/maven-doxia-sitetools.git
commit 0e4b2e2002d799b4b83bb8be9dce9f59af47232d
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Sun Jan 29 18:32:11 2023 +0100
[DOXIASITETOOLS-285] Deprecate SiteRenderingContext#defaultWindowTitle in favor of SiteRenderingContext#defaultTitle
---
.../doxia/siterenderer/DefaultSiteRenderer.java | 14 ++++-----
.../apache/maven/doxia/siterenderer/Renderer.java | 4 +--
.../doxia/siterenderer/SiteRenderingContext.java | 34 +++++++++++++++++-----
.../siterenderer/DefaultSiteRendererTest.java | 4 +--
4 files changed, 37 insertions(+), 19 deletions(-)
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
index 4b2b170..c895f80 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
@@ -603,13 +603,13 @@ public class DefaultSiteRenderer
// DOXIASITETOOLS-70: Prepend the project name to the title, if any
StringBuilder title = new StringBuilder();
if ( siteRenderingContext.getDecoration() != null
- && siteRenderingContext.getDecoration().getName() != null )
+ && StringUtils.isNotEmpty( siteRenderingContext.getDecoration().getName() ) )
{
title.append( siteRenderingContext.getDecoration().getName() );
}
- else if ( siteRenderingContext.getDefaultWindowTitle() != null )
+ else if ( StringUtils.isNotEmpty( siteRenderingContext.getDefaultTitle() ) )
{
- title.append( siteRenderingContext.getDefaultWindowTitle() );
+ title.append( siteRenderingContext.getDefaultTitle() );
}
if ( title.length() > 0 && StringUtils.isNotEmpty( content.getTitle() ) )
@@ -719,25 +719,25 @@ public class DefaultSiteRenderer
}
private SiteRenderingContext createSiteRenderingContext( Map<String, ?> attributes, DecorationModel decoration,
- String defaultWindowTitle, Locale locale )
+ String defaultTitle, Locale locale )
{
SiteRenderingContext context = new SiteRenderingContext();
context.setTemplateProperties( attributes );
context.setLocale( locale );
context.setDecoration( decoration );
- context.setDefaultWindowTitle( defaultWindowTitle );
+ context.setDefaultTitle( defaultTitle );
return context;
}
/** {@inheritDoc} */
public SiteRenderingContext createContextForSkin( Artifact skin, Map<String, ?> attributes,
- DecorationModel decoration, String defaultWindowTitle,
+ DecorationModel decoration, String defaultTitle,
Locale locale )
throws IOException, RendererException
{
- SiteRenderingContext context = createSiteRenderingContext( attributes, decoration, defaultWindowTitle, locale );
+ SiteRenderingContext context = createSiteRenderingContext( attributes, decoration, defaultTitle, locale );
context.setSkin( skin );
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
index 254b3c2..8bb2a14 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
@@ -70,7 +70,7 @@ public interface Renderer // TODO rename to SiteRenderer
* @param skin a skin
* @param attributes attributes to use
* @param decoration a decoration model
- * @param defaultWindowTitle default window title
+ * @param defaultTitle default title
* @param locale locale to use
* @return a SiteRenderingContext.
* @throws RendererException if it bombs.
@@ -78,7 +78,7 @@ public interface Renderer // TODO rename to SiteRenderer
* @since 1.7.3 was previously with skin as File instead of Artifact
*/
SiteRenderingContext createContextForSkin( Artifact skin, Map<String, ?> attributes, DecorationModel decoration,
- String defaultWindowTitle, Locale locale )
+ String defaultTitle, Locale locale )
throws RendererException, IOException;
/**
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
index 1b4c57b..357af21 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
@@ -56,7 +56,7 @@ public class SiteRenderingContext
private DecorationModel decoration;
- private String defaultWindowTitle;
+ private String defaultTitle;
private Artifact skin;
@@ -211,23 +211,41 @@ public class SiteRenderingContext
}
/**
- * <p>Setter for the field <code>defaultWindowTitle</code>.</p>
+ * @deprecated use {@link #setDefaultTitle(String)}
+ */
+ @Deprecated
+ public void setDefaultWindowTitle( String defaultWindowsTitle )
+ {
+ setDefaultTitle( defaultWindowsTitle );
+ }
+
+ /**
+ * <p>Setter for the field <code>defaultTitle</code>.</p>
*
- * @param defaultWindowTitle a {@link java.lang.String} object.
+ * @param defaultTitle a {@link java.lang.String} object.
+ */
+ public void setDefaultTitle( String defaultTitle )
+ {
+ this.defaultTitle = defaultTitle;
+ }
+
+ /**
+ * @deprecated use {@link #getDefaultTitle()}
*/
- public void setDefaultWindowTitle( String defaultWindowTitle )
+ @Deprecated
+ public String getDefaultWindowTitle()
{
- this.defaultWindowTitle = defaultWindowTitle;
+ return getDefaultTitle();
}
/**
- * <p>Getter for the field <code>defaultWindowTitle</code>.</p>
+ * <p>Getter for the field <code>defaultTitle</code>.</p>
*
* @return a {@link java.lang.String} object.
*/
- public String getDefaultWindowTitle()
+ public String getDefaultTitle()
{
- return defaultWindowTitle;
+ return defaultTitle;
}
/**
diff --git a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
index 2ccc2b5..4778603 100644
--- a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
+++ b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
@@ -339,7 +339,7 @@ public class DefaultSiteRendererTest
VersionRange.createFromVersion( "1.1" ), null, "jar", "", null );
skin.setFile( skinFile );
SiteRenderingContext siteRenderingContext =
- renderer.createContextForSkin( skin, attributes, new DecorationModel(), "defaultWindowTitle",
+ renderer.createContextForSkin( skin, attributes, new DecorationModel(), "defaultitle",
Locale.ROOT );
RenderingContext context = new RenderingContext( new File( "" ), "document.html", "generator" );
SiteRendererSink sink = new SiteRendererSink( context );
@@ -373,7 +373,7 @@ public class DefaultSiteRendererTest
VersionRange.createFromVersion( "1.1" ), null, "jar", "", null );
skin.setFile( skinFile );
SiteRenderingContext siteRenderingContext =
- renderer.createContextForSkin( skin, attributes,decoration, "defaultWindowTitle",
+ renderer.createContextForSkin( skin, attributes,decoration, "defaultTitle",
Locale.ROOT );
siteRenderingContext.addSiteDirectory( getTestFile( siteDir ) );
siteRenderingContext.setValidate( validate );