[Java8]-String新特性-StringJoiner源码解析学习

java中新增了一个类StringJoin,可以对字符串进行自由的格式话,下面就进行介绍:

用于构造分隔的字符序列,使用分隔符,并且可以选择以提供的前缀开头,以提供的后缀结尾。

1. StringJoin源码解析

1.1属性

  1. 字符串拼接的前缀,私有并且是 一旦赋值不可更改的String类型变量。
` private final String prefix;`
  1. 字符串拼接后缀,私有并且一旦赋值不可更改的String类型变量。
    private final String suffix;
  2. 字符串拼接后缀,私有并且一旦赋值不可更改的String类型变量。
    private final String delimiter;
  3. 私有的StringBuilder实例。StringBuilder—在任何时候,由前缀构造的字符,添加的元素由分隔符分隔,但没有后缀,因此我们可以更容易地添加元素,而不必每次都修改后缀。
    private StringBuilder value;

源码供上


public final class StringJoiner {
    /** 前缀  */
    private final String prefix;
    /** 分隔符*/
  `
  private final String delimiter;`
  
    /** 后缀*/
    private final String suffix;

    /*
     *StringBuilder值——在任何时候,由前缀构造的字符,添加的元素由分隔符分隔,
     *但没有后缀,因此我们可以更轻松地添加元素,而不必每次都移动后缀。
     */
    private StringBuilder value;

    /*
     *默认情况下,由toString()返回的prefix+suffix组成的字符串,
     *或在尚未添加任何元素(即为空)时的value属性。
     *用户可能会将其重写为其他值,包括空 字符串。
     */
    private String emptyValue;

    /**
     * @param  delimiter 分隔符 
     * @throws NullPointerException if {@code delimiter} is {@code null}
     */
    public StringJoiner(CharSequence delimiter) {
        this(delimiter, "", "");
    }

    /**
     * @param  delimiter 分隔符
     * @param  prefix 前缀
     * @param  suffix 后缀
     * @throws 如果这些值设置为NUll 会抛出NullPointerException 
     */
    public StringJoiner(CharSequence delimiter,
                        CharSequence prefix,
                        CharSequence suffix) {
        Objects.requireNonNull(prefix, "The prefix must not be null");
        Objects.requireNonNull(delimiter, "The delimiter must not be null");
        Objects.requireNonNull(suffix, "The suffix must not be null");
        // make defensive copies of arguments
        this.prefix = prefix.toString();
        this.delimiter = delimiter.toString();
        this.suffix = suffix.toString();
        this.emptyValue = this.prefix + this.suffix;
    }

    /**
     *Java 8中的StringJoiner类的方法设置字符序列。
     *在确定此StringJoiner的字符串表示形式以及该字符串为空时,将使用这些字符。
     *那将是没有添加任何元素。
     *
     * @param 空StringJoiner的值返回的字符
     * @return this {@code StringJoiner} itself so the calls may be chained
     * @throws NullPointerException when the {@code emptyValue} parameter is
     *         {@code null}
     */
    public StringJoiner setEmptyValue(CharSequence emptyValue) {
        this.emptyValue = Objects.requireNonNull(emptyValue,
            "The empty value must not be null").toString();
        return this;
    }
  
    /**StringBuilder转化为String了. */
    @Override
    public String toString() {
        if (value == null) {
            return emptyValue;
        } else {
            if (suffix.equals("")) {
                return value.toString();
            } else {
                int initialLength = value.length();
                String result = value.append(suffix).toString();
                // reset value to pre-append initialLength
                value.setLength(initialLength);
                return result;
            }
        }
    }
    /**
     *添加给定{@code CharSequence}值的副本作为{@code StringJoiner}值的下一个元素。     *如果{@code newElement}{@code null},则添加{@code“null”}。
     * @param  newElement 添加的字符串
     * @return 返回拼接的结果
     */
    public StringJoiner add(CharSequence newElement) {
        prepareBuilder().append(newElement);
        return this;
    }

    /**
     * Adds the contents of the given {@code StringJoiner} without prefix and
     * suffix as the next element if it is non-empty. If the given {@code
     * StringJoiner} is empty, the call has no effect.
     *
     * <p>A {@code StringJoiner} is empty if {@link #add(CharSequence) add()}
     * has never been called, and if {@code merge()} has never been called
     * with a non-empty {@code StringJoiner} argument.
     *
     * <p>If the other {@code StringJoiner} is using a different delimiter,
     * then elements from the other {@code StringJoiner} are concatenated with
     * that delimiter and the result is appended to this {@code StringJoiner}
     * as a single element.
     *
     * @param other The {@code StringJoiner} whose contents should be merged
     *              into this one
     * @throws NullPointerException if the other {@code StringJoiner} is null
     * @return This {@code StringJoiner}
     */
    public StringJoiner merge(StringJoiner other) {
        Objects.requireNonNull(other);
        if (other.value != null) {
            final int length = other.value.length();
            // lock the length so that we can seize the data to be appended
            // before initiate copying to avoid interference, especially when
            // merge 'this'
            StringBuilder builder = prepareBuilder();
            builder.append(other.value, other.prefix.length(), length);
        }
        return this;
    }

    private StringBuilder prepareBuilder() {
        if (value != null) {
            value.append(delimiter);
        } else {
            value = new StringBuilder().append(prefix);
        }
        return value;
    }

    /**
     * Returns the length of the {@code String} representation
     * of this {@code StringJoiner}. Note that if
     * no add methods have been called, then the length of the {@code String}
     * representation (either {@code prefix + suffix} or {@code emptyValue})
     * will be returned. The value should be equivalent to
     * {@code toString().length()}.
     *
     * @return the length of the current value of {@code StringJoiner}
     */
    public int length() {
        // Remember that we never actually append the suffix unless we return
        // the full (present) value or some sub-string or length of it, so that
        // we can add on more if we need to.
        return (value != null ? value.length() + suffix.length() :
                emptyValue.length());
    }
}

2.使用例子

2.1 分割添加

2.1.1方式一


  public static void main(String[] args) {
        // 添加元素方法
        String delimiter = "!";
        StringJoiner stringJoiner = new StringJoiner(delimiter);
        stringJoiner.add("hi");
        stringJoiner.add("newzhong");
        System.out.println(stringJoiner.toString());
    }

结果:

image

2.1.2方式二 使用Stream

    public static void main(String[] args) {
        List<String> stringList = new ArrayList<>(3);
        stringList.add("a");
        stringList.add("b");
        stringList.add("c");

        String collect = stringList.stream().collect(Collectors.joining("@"));
        System.out.println(collect);
    }

结果:

image

2.2.合并merge

 public static void main(String[] args) {

        StringJoiner stringJoiner1 = new StringJoiner("_");
        stringJoiner1.add("1").add("2").add("3");
        System.out.println("stringJoiner1:"+ stringJoiner1.toString());
        StringJoiner stringJoiner2 = new StringJoiner("#");
        stringJoiner2.add("4").add("5").add("6");
        System.out.println("stringJoiner2:" + stringJoiner2.toString());

         stringJoiner1.merge(stringJoiner2);
        System.out.println("merge:" + stringJoiner1);
    }

结果:

image

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,036评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,046评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,411评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,622评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,661评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,521评论 1 304
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,288评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,200评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,644评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,837评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,953评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,673评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,281评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,889评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,011评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,119评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,901评论 2 355

推荐阅读更多精彩内容