org.apache.poi.hslf.model.textproperties.BitMaskTextProp Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi-scratchpad Show documentation
Apache POI - Java API To Access Microsoft Format Files
There is a newer version: 5.2.5
/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */

package org.apache.poi.hslf.model.textproperties;

import static org.apache.poi.util.GenericRecordUtil.getBitsAsString;

import java.util.Map;
import java.util.function.Supplier;

import org.apache.poi.util.GenericRecordUtil;
import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger;

/**
 * Definition of a special kind of property of some text, or its
 *  paragraph. For these properties, a flag in the "contains" header
 *  field tells you the data property family will exist. The value
 *  of the property is itself a mask, encoding several different
 *  (but related) properties
 */
public abstract class BitMaskTextProp extends TextProp {
    protected static final POILogger logger = POILogFactory.getLogger(BitMaskTextProp.class);

    private String[] subPropNames;
	private int[] subPropMasks;
	private boolean[] subPropMatches;

	/** Fetch the list of the names of the sub properties */
	public String[] getSubPropNames() { return subPropNames; }
	/** Fetch the list of if the sub properties match or not */
	public boolean[] getSubPropMatches() { return subPropMatches; }


	protected BitMaskTextProp(BitMaskTextProp other) {
		super(other);
		subPropNames = (other.subPropNames == null) ? null : other.subPropNames.clone();
		subPropMasks = (other.subPropMasks == null) ? null : other.subPropMasks.clone();

		// The old clone implementation didn't carry over matches, but keep everything else as it was
		// this is failing unit tests
		// subPropMatches = (other.subPropMatches == null) ? null : new boolean[other.subPropMatches.length];
		subPropMatches = (other.subPropMatches == null) ? null : other.subPropMatches.clone();
	}


	protected BitMaskTextProp(int sizeOfDataBlock, int maskInHeader, String overallName, String... subPropNames) {
		super(sizeOfDataBlock,maskInHeader,overallName);
		this.subPropNames = subPropNames;
		subPropMasks = new int[subPropNames.length];
		subPropMatches = new boolean[subPropNames.length];

		int LSB = Integer.lowestOneBit(maskInHeader);

		// Initialise the masks list
		for(int i=0; i> getGenericProperties() {
		return GenericRecordUtil.getGenericProperties(
			"base", super::getGenericProperties,
			"flags", getBitsAsString(this::getValue, subPropMasks, subPropNames)
		);
	}

	@Override
	public abstract BitMaskTextProp copy();
}